Create Actions Walkthrough (#36)

* starting walkthrough docs

* versioning
This commit is contained in:
Bryan MacFarlane
2019-08-01 11:26:17 -04:00
committed by GitHub
parent 4a7f2143e6
commit 3977d56fd3
8 changed files with 326 additions and 33 deletions

29
docs/action-versioning.md Normal file
View File

@@ -0,0 +1,29 @@
# Versioning
Actions are downloaded and run from the GitHub graph of repos. The workflow references an action use a ref.
Examples:
```yaml
steps:
- use: actions/setup-node@74bc508
- user: actions/setup-node@v1
- uses: actions/setup-node@master
```
Binding to the immutable sha1 of a released version is the safest for stability and security.
Binding to a specific major version allows for receiving critical fixes and security patches while still mainting compatibility and the assurance your workflow should still work.
Binding to master is convenient but if a new major version is release which breaks compatilibility, your workflow could break.
# Recommendations
1. **Create a release**: use sematic versioning for the release (v1.0.9)
2. **Update the major version tag**: move the major version tag (v1, v2, etc.) to point to the ref of the current release.
3. **Compaitbility Breaks**: introduce a new major version tag (v2) if changes will break existing workflows. For example, changing inputs.
See [Git-Basics-Tagging](https://git-scm.com/book/en/v2/Git-Basics-Tagging)