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:
- If you haven't yet, add the main Evergreen repo (on GitHub) as a remote
git remote add github-evergreen https://github.com/evergreen-library-system/Evergreen.git
- Update your local master branch to reflect any changes from "origin"
git checkout master; git fetch origin; git pull origin master
- Fetch the pull request branch into a new local branch
git fetch github-evergreen pull/[PULL_REQ_NUMBER]/head:[BRANCHNAME]
- Checkout your new pull request branch
git checkout [BRANCHNAME]
- Rebase the pull request branch to master, and handle any conflicts
git rebase master
– note: if you are planning to squash multiple commits into a single commit, this is a good time to do it by running this command with the-i
flag, i.e.git rebase -i master
. If you are using-i
, git will open your preferred text editor, where you can indicate which commits you'd like to squash.
- Test build the changed AsciiDoc file + the nav.adoc file(s) that include it
- For testing only, add the name of your branch to site.yml
perl ./generate_docs.pl –base-url http://examplesite.org/prod
- 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 "conversation")
- Docs images belong in
Evergreen/docs/modules/<module_name>/assets/images/media/
- Also look for other AsciiDoc warnings or errors
- Make any corrections (via additional commits, if needed)
- Use
git log
to retrieve commit IDs - Add the commits to your local master, adding your sign-off
git checkout master
git cherry-pick -s [commit ID]
- Include the relevant Launchpad bug number somewhere in the commit message
- Example: "Resolves LP#1234567"
- (If the GitHub author does not match the author's identity in git.evergreen-ils.org, consider fixing it with
git commit --amend --author="NAME <email>"
)
- When you are confident your local master branch is 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.1621397904.txt.gz · Last modified: 2022/02/10 13:34 (external edit)