diff --git a/docs/action-versioning.md b/docs/action-versioning.md index 534a1b19..65066a83 100644 --- a/docs/action-versioning.md +++ b/docs/action-versioning.md @@ -8,14 +8,14 @@ Examples: steps: - use: actions/setup-node@74bc508 - user: actions/setup-node@v1 - - uses: actions/setup-node@master + - uses: actions/setup-node@master # not recommended ``` 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. +Binding to master is convenient but if a new major version is released which breaks compatilibility, your workflow could break. # Recommendations diff --git a/docs/node12-action.md b/docs/node12-action.md index fee5a3a6..253a62f4 100644 --- a/docs/node12-action.md +++ b/docs/node12-action.md @@ -113,12 +113,12 @@ $ git add $ git commit -m "Message" ``` -## Publish a v1 Action +## Publish a v1-release Action -After changing some files, create a v1 branch which we will release +After changing some files, create a v1-release branch which we will release ```bash -$ git checkout -b v1 +$ git checkout -b v1-release ``` > NOTE: We will provide tooling and an action to automate this soon. @@ -139,6 +139,21 @@ $ git push > NOTE: Consider versioning your actions with tags. See [versioning](docs/action-versioning.md) +## Test End To End + +Once the action has a self contained version in the v1-release branch, you can test it by referencing the latest (and potentially unstable) version in the release branch. If you are fixing an issue that someone else is having with your action, you can have them try it before you officially releasing it as the 'v1' version. + +```yaml +steps: + using: {org}/{reponame}@v1-release +``` + +## Release Current Changes as v1 + +Once you have tested end to end, push a tag of 'v1' to the commit in the release branch. + +See [action versioning](action-versioning.md) for more details. + # Users Referencing Users can now reference your action in their workflows with