Skip to content

[test] do not merge: annotations from fmt, docs, and check-jsonschema - #27

Closed
posquit0 wants to merge 2 commits into
mainfrom
test/check-annotations-remaining
Closed

posquit0 wants to merge 2 commits into
mainfrom
test/check-annotations-remaining

Conversation

@posquit0

Copy link
Copy Markdown
Member

Temporary PR for the annotations added in the fmt/docs/check-jsonschema PR. The fixtures fail on purpose: an unformatted module with a subdirectory (terraform fmt, two hunks), stale READMEs in recursive mode (terraform-docs), a workflow with a non-list steps and an action without a description (check-jsonschema). Will be closed after the run.

…and check-jsonschema

- Add `annotations_enabled` (default `true`) to the three remaining check
  actions on the same pattern as validate, tflint, and actionlint
- `terraform.fmt` reads the file and hunk line from the diff it captured;
  `terraform.docs` reads the stale file from its `is out of date` line; both
  prefix `target_dir` since the tools print module-relative paths
- `github-actions.check-jsonschema` re-runs with `--output-format json`;
  schema validation has no line numbers, so the annotation points at the
  file and names the failing JSON path
@github-actions

Copy link
Copy Markdown

GitHub Actions Integration

Repository actionlint check-jsonschema (workflows) check-jsonschema (actions)
tedilabs/github-actions

✅ All 1 passed.

@posquit0

Copy link
Copy Markdown
Member Author

Verified on ubuntu-latest (run 35524249993) with the actions from #26: terraform fmt annotates the first line of each hunk in tf/main.tf and tf/sub/out.tf (title terraform fmt · Not formatted), terraform-docs annotates the stale docs/README.md (terraform-docs · Out of date), and check-jsonschema annotates workflows/bad.yaml and actions/bad/action.yaml with the failing JSON paths (check-jsonschema · workflows / · actions). The fmt step with annotations_enabled: "false" added nothing. Closing; nothing here is meant to merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant