diff options
| author | Zeke Sikelianos <zeke@github.com> | 2019-09-05 08:42:49 -0700 |
|---|---|---|
| committer | Tingluo Huang <tingluohuang@github.com> | 2019-09-05 11:42:49 -0400 |
| commit | 4762548688a91f2b735daa09f079e3e521be8dcd (patch) | |
| tree | fdd3936fec719518a147cfd45151aa59c8104d80 /README.md | |
| parent | df8410bcaef5b72c336f1ad34a6e633a62849164 (diff) | |
add docs about checking out the triggering ref (#21)
* add docs about checking out the triggering ref
* clarify checkout behavior
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -10,6 +10,7 @@ See [here](https://help.github.com/en/articles/events-that-trigger-workflows) to See [action.yml](action.yml) Basic: + ```yaml steps: - uses: actions/checkout@master @@ -20,6 +21,16 @@ steps: - run: npm test ``` +By default, the branch or tag ref that triggered the workflow will be checked out. If you wish to check out a different branch, specify that using `with.ref`: + +```yaml +- uses: actions/checkout@master + with: + ref: some-branch +``` + +For more details, see [Contexts and expression syntax for GitHub Actions](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions) + # License The scripts and documentation in this project are released under the [MIT License](LICENSE) |