-
-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Improve CI docs * More dos * More docs * Link
- Loading branch information
1 parent
f9877da
commit 4578628
Showing
4 changed files
with
186 additions
and
141 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Workflows | ||
|
||
GitHub Actions uses the concept of _workflows_, which are scripts that run automatically whenever a specific event occurs (e.g. pushing a commit). | ||
|
||
Each GitHub Actions workflow is defined in a `.yml` file in the `.github/workflows` directory. | ||
For information on workflows, check the following docs: | ||
|
||
- [Workflow syntax](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions) | ||
- [Choosing when your workflow runs](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow) | ||
- [Choosing where your workflow runs](https://docs.github.com/en/actions/writing-workflows/choosing-where-your-workflow-runs) | ||
- [Choose what your workflow does](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does) | ||
- [Writing workflows](https://docs.github.com/en/actions/writing-workflows) | ||
- [Best practices](/docs/building/github/gha-best-practices) | ||
|
||
## Shared workflows | ||
|
||
Some workflows are shared across repositories. | ||
These workflows _should not be changed_. | ||
|
||
### General workflows | ||
|
||
- `sync-labels.yml`: automatically syncs the repository's labels from a `labels.yml` file | ||
|
||
### Track-specific workflows | ||
|
||
- `configlet.yml`: runs the [configlet tool](/docs/building/configlet), which checks if a track's (configuration) files are properly structured - both syntactically and semantically | ||
- `no-important-files-changed.yml`: checks if pull requests would cause all existing solutions of one or more changes exercises to be re-run | ||
- `test.yml`: verify the track's exercises | ||
|
||
### Tooling-specific workflows | ||
|
||
- `deploy.yml`: deploy the tooling Docker image to Docker Hub and ECR | ||
|
||
## Custom workflows | ||
|
||
Maintainers are free to add custom workflows to their repos. | ||
Examples of such workflows could be: | ||
|
||
- Linting of shell scripts ([example](https://github.com/exercism/configlet/blob/3baa09608c8ac327315c887608c13a68ae8ac359/.github/workflows/shellcheck.yml)) | ||
- Auto-commenting on pull requests ([example](https://github.com/exercism/elixir/blob/b737f80cc93fcfdec6c53acb7361819834782470/.github/workflows/pr-comment.yml)) | ||
- Etc. |
Oops, something went wrong.