Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

yaml validate example github setups? #266

Closed
sourcefrog opened this issue Jan 26, 2024 · 3 comments · Fixed by #269
Closed

yaml validate example github setups? #266

sourcefrog opened this issue Jan 26, 2024 · 3 comments · Fixed by #269
Assignees
@sourcefrog
Labels
CI Support testing mutants in PRs and CI documentation Improvements or additions to documentation testing About cargo-mutants own test suite

Comments

@sourcefrog
Copy link
Owner

sourcefrog commented Jan 26, 2024 •
edited
Loading

The book includes example YAML config for GitHub actions.

We could potentially

  1. Move it to a separate YAML file that's included into the book. This would incidentally make it easier for people to copy and use.
  2. Then run a YAML schema validator to make sure there are no typos.

There is https://github.com/nektos/act to actually run them locally, but that would take a while, and requires having Docker etc.

There's also https://github.com/mpalmer/action-validator which seems just right.
@sourcefrog sourcefrog added documentation Improvements or additions to documentation CI Support testing mutants in PRs and CI labels Jan 26, 2024
@kevinmatthes
Copy link
Contributor

There is also another Action: https://github.com/devops-actions/actionlint.

It is a wrapper around the GHA validator used by GitHub's official Super Linter.

@sourcefrog
Copy link
Owner Author

hm, thanks!

@sourcefrog sourcefrog assigned sourcefrog and unassigned sourcefrog Jan 26, 2024
sourcefrog added a commit that referenced this issue Jan 26, 2024
@sourcefrog
Run actionlint on all github actions
f9079c1 
Fixes #266
@sourcefrog
Copy link
Owner Author

It looks like action-validator is nice to run locally (but has some gaps like mpalmer/action-validator#70) but maybe actionlint is a good fit for CI.

@sourcefrog sourcefrog self-assigned this Jan 26, 2024
@sourcefrog sourcefrog mentioned this issue Jan 26, 2024
Merged
@sourcefrog sourcefrog added the testing About cargo-mutants own test suite label Feb 2, 2024
sourcefrog added a commit that referenced this issue Feb 2, 2024
@sourcefrog
Validate example GitHub workflows (#269)
8517801 
Split out example workflow yaml into `examples/workflow`.

Run the actionlint validator on all workflows, and fix some nits.

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

@sourcefrog sourcefrog

Labels
CI Support testing mutants in PRs and CI documentation Improvements or additions to documentation testing About cargo-mutants own test suite
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Validate example GitHub workflows sourcefrog/cargo-mutants
2 participants
@sourcefrog @kevinmatthes