actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code

workflow allows for e2e testing

pull/40/head
Bryan MacFarlane 2019-08-04 08:56:16 -04:00
parent 3ce161a815
commit 0bb10220a7
2 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/action-versioning.md
View File

@ -8,14 +8,14 @@ Examples:
steps: steps:
- use: actions/setup-node@74bc508 - use: actions/setup-node@74bc508
- user: actions/setup-node@v1 - 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 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 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 # Recommendations

21
docs/node12-action.md
View File

@ -113,12 +113,12 @@ $ git add <whatever only files you added>
$ git commit -m "Message" $ 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 ```bash
$ git checkout -b v1 $ git checkout -b v1-release
``` ```
> NOTE: We will provide tooling and an action to automate this soon. > 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) > 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 Referencing
Users can now reference your action in their workflows with Users can now reference your action in their workflows with