Repository files navigation

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.

Thank you for your interest in this GitHub repo, however, right now we are not taking contributions.

We continue to focus our resources on strategic areas that help our customers be successful while making developers' lives easier. While GitHub Actions remains a key part of this vision, we are allocating resources towards other areas of Actions and are not taking contributions to this repository at this time. The GitHub public roadmap is the best place to follow along for any updates on features we’re working on and what stage they’re in.

We are taking the following steps to better direct requests related to GitHub Actions, including:

1. We will be directing questions and support requests to ourCommunity Discussions area

2. High Priority bugs can be reported through Community Discussions or you can report these to our support teamhttps://support.github.com/contact/bug-report.

3. Security Issues should be handled as per oursecurity.md

We will still provide security updates for this project and fix major breaking changes during this time.

You are welcome to still raise bugs in this repo.

• ci: solutions for Continuous Integration workflows
• deployments: solutions for Deployment workflows
• automation: solutions for automating workflows
• code-scanning: solutions forCode Scanning
• pages: solutions for Pages workflows
• 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 andci/properties/django.properties.json.

• name: the name shown in onboarding. This property is unique within the repository.
• description: the description shown in onboarding
• iconName: the icon name in the relevant folder, for example,django should have an iconicons/django.svg. Only SVG is supported at this time. Another option is to useocticon. The format to use an octicon isocticon <<icon name>>. Example:octicon person
• creator: creator of the template shown in onboarding. All the workflow templates from an author will have the samecreator field.
• categories: the categories that it will be shown under. Choose at least one category from the listhere. Further, choose the categories from the list of languages availablehere and the list of tech stacks availablehere. When a user views the available templates, those templates that match the language and tech stacks will feature more prominently.

• continuous-integration
• deployment
• testing
• code-quality
• code-review
• dependency-management
• monitoring
• Automation
• utilities
• Pages
• Hugo

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 substitute any protected branches from the repository
• $cron-daily: will substitute a valid but random time within the day

The template author adds alabels array in the template'sproperties.json file with a labelpreview. This will hide the template from users, unless user uses query parameterpreview=true in the URL.Exampleproperties.json file:

{"name":"Node.js","description":"Build and test a Node.js project with npm.","iconName":"nodejs","categories": ["Continuous integration","JavaScript","npm","React","Angular","Vue"],"labels": ["preview"]}

For viewing the templates withpreview label, provide query parameterpreview=true to thenew workflow page URL. Eg.https://github.com/<owner>/<repo_name>/actions/new?preview=true.

Remove thelabels array fromproperties.json file to publish the template to public