A collection of example workflows for GitHub Actions that are used for Julia projects and packages.
Note that these are no longer being updated. Please refer to the bot's and package's documentation for examples. You can find a "complete" CI example in PkgTemplates.jl
| Name | Description | Workflow file |
|---|---|---|
| Package CI | Run common package CI tasks, including tests and coverage reports | ci.yml |
| Registry Automerge Bot | Provides continuous integration (CI) tools, including automated testing and automatic merging (automerge) of pull requests | automerge.yml |
| CompatHelper Bot | Automatically update the [compat] entries for your Julia package's dependencies | CompatHelper.yml |
| Documenter deployment | Deploys docs built by Documenter.jl | docs.yml |
| Update Manifest.toml | Run Pkg.update on Manifest.toml files checked in to the repository |
pkg-update.yml |
You can find general information about GitHub Actions and workflows in the GitHub Docs and on this blogpost.
If you want to get started as quickly as possible, check out CompatHelper.jl's README which contains information on how to add workflows. It's applicable to other workflows as well, though some may require additional configuration.
If you have built an action or workflow to be used with Julia projects, please submit a PR and add your examples!