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.

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

Allow running consistency check for all workflows #213

Open
krzema12 opened this issue Apr 23, 2022 · 0 comments
Open

Allow running consistency check for all workflows #213

krzema12 opened this issue Apr 23, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@krzema12
Copy link
Member

Some workflows run frequently, e. g. building the project is done usually every commit, but releases are done less often. If Kotlin script and YAML diverge, the moment when the user learns about it is at the moment the workflow runs. It then requires patching.

An alternative approach would be to proactively check consistency for all supported workflows, as often as possible, then it would speed up detecting any issues. It could even allow disabling consistency check during workflow runtime.

Rough idea: provide utilities that generate a workflow for calling just the consistency checks of all workflows.

@krzema12 krzema12 added the enhancement New feature or request label Apr 23, 2022
krzema12 added a commit to krzema12/snakeyaml-engine-kmp that referenced this issue Aug 21, 2024
Now that we have a workflow that runs only on demand, and not in every
PR or on the `main` branch, it's beneficial to have these extra checks.

BTW, I noticed this piece is useful in almost every project, and I'm
planning to release some kind of util (a GitHub action?) that would
encapsulate this logic. It's tracked in
typesafegithub/github-workflows-kt#213

Examples of using this approach in other repos:
*
https://github.com/typesafegithub/github-workflows-kt/blob/0e91c566849a5883b39021a5ecbc18d25b006c1b/.github/workflows/build.main.kts#L95
*
https://github.com/typesafegithub/github-actions-typing-catalog/blob/667df7ec3fc639d19e278fc5956a9f753b26bb90/.github/workflows/test.main.kts#L14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant