2.6 KiB
This repository contains configuration for what users see when they click on the Actions tab.
It is not:
- A playground to try out scripts
- A place for you to create a workflow for your repository
Thank you for sending in this pull request. Please make sure you take a look at the contributing file. Here's a few things for you to consider in this pull request.
Please add to this description at the bottom 👇
- A good description of the workflow at the bottom of this page.
- Some links to the language or tool will be nice (unless its really obvious)
In the workflow and properties files:
-
The workflow filename of CI workflows should be the name of the language or platform, in lower case. Special characters should be removed or replaced with words as appropriate (for example, "dotnet" instead of ".NET").
The workflow filename of publishing workflows should be the name of the language or platform, in lower case, followed by "-publish".
-
Includes a matching
ci/properties/*.properties.jsonfile. -
Use sentence case for the names of workflows and steps, for example "Run tests".
-
The name of CI workflows should only be the name of the language or platform: for example "Go" (not "Go CI" or "Go Build")
-
Include comments in the workflow for any parts that are not obvious or could use clarification.
-
CI workflows should run on
pushtobranches: [ master ]andpull_requesttobranches: [ master ]. -
Packaging workflows should run on
releasewithtypes: [ created ].
Some general notes:
- This workflow must only use actions that are produced by GitHub, in the
actionsorganization, or - This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be published to the GitHub Marketplace. Workflows using these actions must reference the action using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file:
# This workflow uses actions that are not certified by GitHub. # They are provided by a third-party and are governed by # separate terms of service, privacy policy, and support # documentation. - This workflow must not send data to any 3rd party service except for the purposes of installing dependencies.
- This workflow must not use a paid service or product.