Files
starter-workflows/README.md
T

27 lines
1.4 KiB
Markdown
Raw Normal View History

2019-08-27 15:35:20 -07:00
<p align="center">
<img src="https://avatars0.githubusercontent.com/u/44036562?s=100&v=4"/>
</p>
## Starter Workflows
2020-02-28 15:24:15 +00:00
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.
2020-02-29 17:04:55 -08:00
**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.**
2019-08-27 15:35:20 -07:00
2020-02-28 15:24:15 +00:00
<img src="https://d3vv6lp55qjaqc.cloudfront.net/items/353A3p3Y2x3c2t2N0c01/Image%202019-08-27%20at%203.25.07%20PM.png" max-width="75%"/>
2019-08-27 15:35:20 -07:00
**Directory structure:**
2019-08-13 20:01:52 +05:30
* [ci](ci): solutions for Continuous Integration
2019-08-27 15:35:20 -07:00
* [automation](automation): solutions for automating workflows.
2019-08-13 20:01:52 +05:30
* [icons](icons): svg icons for the relevant template
2019-07-29 09:38:23 -07:00
2019-08-27 15:35:20 -07:00
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).
2019-07-29 09:38:23 -07:00
For example: `ci/python-django.yml` and `ci/properties/python-django.properties.json`.
2019-07-29 09:38:23 -07:00
2019-08-27 15:35:20 -07:00
**Valid properties:**
2019-07-29 09:38:23 -07:00
* `name`: the name shown in onboarding
* `description`: the description shown in onboarding
2019-08-27 15:35:20 -07:00
* `iconName`: the icon name in the relevant folder, for example `django` should have an icon `icons/django.svg`. Only SVG is supported at this time
2019-08-12 09:39:12 -04:00
* `categories`: the categories that it will be shown under