evergreen-docs:github-workflow
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
evergreen-docs:github-workflow [2022/05/12 09:23] – review github's built docs, rather than compiling the docs yourself sandbergja | evergreen-docs:github-workflow [2023/12/28 15:54] (current) – aneiman | ||
---|---|---|---|
Line 21: | Line 21: | ||
- On the commits tab, note how many new commits are in the pull request -- you will need this information later. | - On the commits tab, note how many new commits are in the pull request -- you will need this information later. | ||
- | - In your terminal, if you haven' | + | - In your terminal, if you haven' |
- '' | - '' | ||
- | - Update your local master | + | - Update your local main branch to reflect any changes from " |
- | - '' | + | - '' |
- Fetch the pull request branch into a new local branch | - Fetch the pull request branch into a new local branch | ||
- '' | - '' | ||
- | - Cherry pick the relevant commits into your local copy of the master | + | - Cherry pick the relevant commits into your local copy of the main branch. |
- If only one commit: '' | - If only one commit: '' | ||
- If more than one: '' | - If more than one: '' | ||
- The '' | - The '' | ||
+ | - If you need to squash commits: | ||
+ | - From your local branch, enter '' | ||
+ | - Your text editor will open and should show both of the commits, for example: | ||
+ | - '' | ||
+ | - '' | ||
+ | - Change the word '' | ||
+ | - Check gitlog to ensure that you now have a single commit | ||
- Make any corrections (via additional commits, if needed) | - Make any corrections (via additional commits, if needed) | ||
- Use '' | - Use '' | ||
Line 37: | Line 44: | ||
- Example: " | - Example: " | ||
- (If the GitHub author does not match the author' | - (If the GitHub author does not match the author' | ||
- | - When you are confident your local master | + | - When you are confident your local main branch is ready: '' |
- Backport to previous EG versions as appropriate | - Backport to previous EG versions as appropriate | ||
- '' | - '' | ||
- '' | - '' | ||
- | - If one commit: '' | + | - If one commit: '' |
- | - If more than one: '' | + | - If more than one: '' |
- '' | - '' | ||
- Go back to the pull request on Github' | - Go back to the pull request on Github' |
evergreen-docs/github-workflow.1652361800.txt.gz · Last modified: 2022/05/12 09:23 by sandbergja