These are the workflow files for helping people get started with GitHub Actions. They're presented whenever you start to create a new GitHub Actions workflow.
If you want to get started with GitHub Actions, you can use these starter workflows by clicking the "Actions" tab in the repository where you want to create a workflow.
- ci: solutions for Continuous Integration
- automation: solutions for automating workflows.
- code-scanning: starter workflows for Code Scanning
- icons: svg icons for the relevant template
Each workflow must be written in YAML and have a .yml
extension. They also need a corresponding .properties.json
file that contains extra metadata about the workflow (this is displayed in the GitHub.com UI).
For example: ci/django.yml
and ci/properties/django.properties.json
.
name
: the name shown in onboardingdescription
: the description shown in onboardingiconName
: the icon name in the relevant folder, for exampledjango
should have an iconicons/django.svg
. Only SVG is supported at this timecategories
: the categories that it will be shown under
These variables can be placed in the starter workflow and will be substituted as detailed below:
$default-branch
: will substitute the branch from the repository, for examplemain
andmaster
$protected-branches
: will substitue any protected branches from the repository.$cron-daily
: will substitute a valid but random time within the day