add docs about checking out the triggering ref #21
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
approved these changes
Sep 5, 2019
jasonkarns
reviewed
Nov 7, 2019
| @@ -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`: | |||
There was a problem hiding this comment.
This isn't quite right. The branch/tag's HEAD will be checked out, which means (by default) the repo is in a Detached HEAD state. That's different than checking out the branch or tag, which is not a detached HEAD.
There was a problem hiding this comment.
Thanks for the clarification. Do you want to open a followup PR to make these docs more clear?
There was a problem hiding this comment.
how to checkout to the branch without bing detached?
There was a problem hiding this comment.
@sfc-gh-zhwang you should be able to fork the repo, clone it, and work off the main branch.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See #20
cc @TingluoHuang