starter-workflows
starter-workflows copied to clipboard
Node 18
Tasks
For all workflows, the workflow:
- [ ] Should be contained in a
.yml
file with the language or platform as its filename, in lower, kebab-cased format (for example,docker-image.yml
). Special characters should be removed or replaced with words as appropriate (for example, "dotnet" instead of ".NET"). - [ ] Should use sentence case for the names of workflows and steps (for example, "Run tests").
- [ ] Should be named only by the name of the language or platform (for example, "Go", not "Go CI" or "Go Build").
- [ ] Should include comments in the workflow for any parts that are not obvious or could use clarification.
For CI workflows, the workflow:
- [x] Should be preserved under the
ci
directory. - [x] Should include a matching
ci/properties/*.properties.json
file (for example,ci/properties/docker-publish.properties.json
). - [x] Should run on
push
tobranches: [ $default-branch ]
andpull_request
tobranches: [ $default-branch ]
. - [ ] Packaging workflows should run on
release
withtypes: [ created ]
. - [ ] Publishing workflows should have a filename that is the name of the language or platform, in lower case, followed by "-publish" (for example,
docker-publish.yml
).
For Code Scanning workflows, the workflow:
- [ ] Should be preserved under the
code-scanning
directory. - [ ] Should include a matching
code-scanning/properties/*.properties.json
file (for example,code-scanning/properties/codeql.properties.json
), with properties set as follows:- [ ]
name
: Name of the Code Scanning integration. - [ ]
organization
: Name of the organization producing the Code Scanning integration. - [ ]
description
: Short description of the Code Scanning integration. - [ ]
categories
: Array of languages supported by the Code Scanning integration. - [ ]
iconName
: Name of the SVG logo representing the Code Scanning integration. This SVG logo must be present in theicons
directory.
- [ ]
- [ ] Should run on
push
tobranches: [ $default-branch, $protected-branches ]
andpull_request
tobranches: [ $default-branch ]
. We also recommend aschedule
trigger ofcron: $cron-weekly
(for example,codeql.yml
).
Some general notes:
- [ ] This workflow must only use actions that are produced by GitHub, in the
actions
organization, 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. We require that these actions be referenced 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.
- [ ] Automation and CI workflows should not send data to any 3rd party service except for the purposes of installing dependencies.
- [ ] Automation and CI workflows cannot be dependent on a paid service or product.
- drop node 12.x and add node 16.x
- update default node to v16
cc @andymckay @joshmgross
This pull request has become stale and will be closed automatically within a period of time. Sorry about that.
Any update on this?
@chenrui333 : Will you be able to include the proposed changes to the PR? I would love to see get this merged asap as it is kind of a blocker for something we are currently building. 😉
Happy to take this over if you do not have the time 🙂
@davelosert I think you can take this up if this is urgent.
@Phantsure : I opened a second pull request #1735 with the changes I require (update all Ci-related workflows)
Closing this PR as already addressed in https://github.com/actions/starter-workflows/pull/1735