actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code
toolkit/docs/action-versioning.md

3.1 KiB
Raw Blame History

Versioning

Actions are downloaded and run from the GitHub graph of repos. The workflow references an action using a ref.

Examples:

steps:
    - uses: actions/javascript-action@v1        # recommended. starter workflows use this
    - user: actions/javascript-action@v1.0.0    # if an action offers specific releases 
    - uses: actions/javascript-action@41775a4   # binding to a specific sha

Compatibility

Binding to a major version is the latest of that major version ( e.g. v1 == "1.*" )

Major versions should guarantee compatibility. A major version can add net new capabilities but should not break existing input compatibility or break existing workflows.

Major version binding allows you to take advantage of bug fixes and critical functionality and security fixes. The master branch has the latest code and is unstable to bind to since a breaking new major version may first get implemented in master.

Warning: do not reference master since that is the latest code and can be carrying breaking changes of the next major version.

steps:
    - uses: actions/javascript-action@master  # do not do this

Binding to the immutable sha1 may offer more reliability. However, note that the hosted images toolsets (e.g. ubuntu-latest) move forward and if there is a tool breaking issue, actions may react with a patch to a major version to compensate so binding to a specific SHA may prevent you from getting fixes.

Recommendation: bind to major versions to get functionality and fixes but reserve binding to a specific release or SHA as a mitigation strategy for unforeseen breaks.

Recommendations

  1. Create a release branch for each major version: For example, releases\v1. This will allow for releases of that major version while the development of a different major version proceeds.

  2. Validate changes referencing the release branch:

steps:
    - uses: actions/sample-action@releases/v1

  1. Create a GitHub release for each specific version: Creating a release like v1.0.0 allows users to bind back to a specific version if an issue is encountered with the latest major version.

  2. Release that version by updating the major version tag: Move the major version tag (v1, v2, etc.) to point to the ref of the current release. This will act as the stable release for that major version. You should keep this tag updated to the most recent stable minor/patch release.

git checkout releases/v1
git tag -fa v1 -m "Update v1 tag"
git push origin v1 --force

This will result in a major version tag and the latest specific version pointing to the same SHA. See javascript-action tags as an example.

  1. Compatibility Breaks: introduce a new major version branch (releases/v2) and tag (v2) if changes will break existing workflows. For example, changing inputs.

See Git-Basics-Tagging

Sample Workflow

This illustrates the versioning workflow covered above.

versioning