docs: Improve custom branch clarity #761
Merged
Conversation
This file contains 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
By default, I run `git push origin master` instead of `git push origin main` when first creating a repository, so I didn't realize why my deploy step was being skipped, until I realized that `refs/heads/main` should also be changed to `refs/heads/master` when changing the default branch. Below, I added 3 lines of comments explaining to the user that they should also modify the `refs/heads/...` portion of the code when changing the default branch I think that this change would help people that are copy pasting the code to try to get the example to work, so they know what values to change when modifying their branch.
peaceiris
changed the title
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.
By default, I run
git push origin masterinstead ofgit push origin mainwhen first creating a repository, so I didn't realize why my deploy step was being skipped, until I realized thatrefs/heads/mainshould also be changed torefs/heads/masterwhen changing the default branch.Below, I added 3 lines of comments explaining to the user that they should also modify the
refs/heads/...portion of the code when changing the default branchI think that this change would help people that are copy pasting the code to try to get the example to work, so they know what values to change when modifying their branch.