evergreen-docs:github-workflow
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
evergreen-docs:github-workflow [2018/12/06 12:34] – sandbergja | evergreen-docs:github-workflow [2023/12/28 15:23] – aneiman | ||
---|---|---|---|
Line 3: | Line 3: | ||
When someone [[evergreen-docs: | When someone [[evergreen-docs: | ||
- | | + | ===== Reviewing the pull request ===== |
+ | |||
+ | | ||
+ | - Open the pull request in the Github web interface. | ||
+ | - Open the Files Changed tab | ||
+ | - Make sure the asciidoc changes look good | ||
+ | - Open the Checks tab | ||
+ | - Expand the " | ||
+ | - Open the Artifacts menu and select built-docs | ||
+ | - Unzip the artifact and open it in your browser. | ||
+ | - Check to make sure that the expected changes look good in the built docs, and that there are no unexpected changes. | ||
+ | |||
+ | |||
+ | ===== Committing the changes ===== | ||
+ | |||
+ | If everything looks good: | ||
+ | |||
+ | - 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' | ||
- '' | - '' | ||
- | - 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 | ||
- '' | - '' | ||
- | - Checkout | + | - Cherry pick the relevant commits into your local copy of the main branch. |
- | - '' | + | - If only one commit: |
- | - Rebase the pull request branch to master, and handle any conflicts | + | - If more than one: '' |
- | - '' | + | - The '' |
- | - Test build the changed AsciiDoc file + the root*.adoc files that include it | + | - If you need to squash commits: |
- | | + | - Verify that you are in your local branch. |
- | * Ignore warnings for not finding any image files, but be sure to review any included images on GitHub before committing them | + | - If your branch is already built on current main, you can use: '' |
- | * NOTE: You need to download and add the docs images into the git branch, if they aren't in the branch already (e.g. if the images are posted in the GitHub " | + | - Your text editor will open and should show both of the commits, for example: |
- | | + | - pick [COMMIT HASH 1] [COMMIT MESSAGE 1] |
- | * Also look for other AsciiDoc warnings or errors | + | - pick [COMMIT HASH 2] [COMMIT MESSAGE 2] |
+ | - Change the word " | ||
+ | | ||
+ | - fixup --> merges commits like squash does, but discards previous commit message | ||
+ | - Push the commit again, and force it to overwrite | ||
+ | | ||
- Make any corrections (via additional commits, if needed) | - Make any corrections (via additional commits, if needed) | ||
- | - Use interactive rebase to add the commits to your local master, adding your sign-off | + | - Use '' |
- | - '' | + | - Make sure that the commit message begins with " |
- | - '' | + | - Make sure the commit message includes |
- | * Include | + | |
- | | + | - (If the GitHub author does not match the author' |
- | * Out-dent the sign-off line (if present) | + | - When you are confident your local main branch is ready: '' |
- | * Add newlines to long commit messages, making lines about 72 characters long | + | |
- | * (If the GitHub author does not match the author' | + | |
- | - When you are confident your local master | + | |
- Backport to previous EG versions as appropriate | - Backport to previous EG versions as appropriate | ||
- | | + | |
- | - Close pull request on GitHub | + | - '' |
+ | - If one commit: '' | ||
+ | - If more than one: '' | ||
+ | - '' | ||
+ | - Go back to the pull request on Github' |
evergreen-docs/github-workflow.txt · Last modified: 2023/12/28 15:54 by aneiman