typesafegithub / typesafegithub/github-workflows-kt
Allow running consistency check for all workflows
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 664
- Forks
- 30
- Avg merge
- 4d 19h
- Merged PRs (30d)
- 5
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing consistency checks for supported workflows and the workflow-generation entry points. Define how a generated workflow would invoke all checks and how runtime checks could be disabled; done means the consistency of all supported workflows can be checked proactively without requiring each workflow to run.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, kotlin
- Domain
- ci-cd, devops
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100