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 [2020/10/27 14:42] – aneiman | ||
---|---|---|---|
Line 12: | Line 12: | ||
- '' | - '' | ||
- Rebase the pull request branch to master, and handle any conflicts | - Rebase the pull request branch to master, and handle any conflicts | ||
- | - '' | + | - '' |
- | - Test build the changed AsciiDoc file + the root*.adoc files that include it | + | - Test build the changed AsciiDoc file + the nav.adoc file(s) |
* '' | * '' | ||
* Ignore warnings for not finding any image files, but be sure to review any included images on GitHub before committing them | * Ignore warnings for not finding any image files, but be sure to review any included images on GitHub before committing them | ||
* 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 " | * 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 " | ||
- | * Docs images belong in '' | + | * Docs images belong in '' |
* Also look for other AsciiDoc warnings or errors | * Also look for other AsciiDoc warnings or errors | ||
- Make any corrections (via additional commits, if needed) | - Make any corrections (via additional commits, if needed) | ||
- | - Use interactive rebase | + | - Use '' |
+ | - Add the commits to your local master, adding your sign-off | ||
- '' | - '' | ||
- | - '' | + | - '' |
* Include the relevant Launchpad bug number somewhere in the commit message | * Include the relevant Launchpad bug number somewhere in the commit message | ||
* Example: " | * Example: " | ||
- | * Out-dent the sign-off line (if present) | ||
- | * Add newlines to long commit messages, making lines about 72 characters long | ||
* (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 branch is ready: '' | - When you are confident your local master branch is ready: '' |
evergreen-docs/github-workflow.txt · Last modified: 2024/07/10 08:03 by sandbergja