evergreen-docs:github-workflow
This is an old revision of the document!
Docs GitHub Workflow
When someone submits a change via GitHub, an Evergreen developer should follow these steps to review it:
git pull https://github.com/hektech/Evergreen patch-[number]
(wherepatch-[number]
is the branch name)git fetch origin && git rebase origin/master
- Test build the changed AsciiDoc file
asciidoc -a data-uri -a icons -a toc -d book -o OUTPUT_FILE ASCIIDOC_FILE
- Ignore warnings for not finding any image files, but be sure to review the images on GitHub before committing them
- Make any corrections (via additional commits, if needed)
- Sign off on each commit:
git cherry-pick -s [commit-hash]
orgit commit –amend -s
- (If the GitHub author does not match the author's identity in git.evergreen-ils.org, consider fixing it with
–author="NAME <email>"
) - Prepend the relevant Launchpad bug number to the commit title
- Example: "LP#1234567: Fix docs typos"
- Out-dent the sign-off line (if present)
- Add newlines to long commit messages, making lines about 72 characters long
- When you are confident your commits are ready:
git push origin master
- Backport to previous EG versions as appropriate
- Email docs list and/or pull requester to say it is done (or with other feedback)
- Close pull request on GitHub
evergreen-docs/github-workflow.1409330046.txt.gz · Last modified: 2022/02/10 13:34 (external edit)