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:
- Note how many new commits are in the pull request – you will need this information later.
- 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]
- Cherry pick the relevant commits into your local copy of the master branch.
- If only one commit:
git cherry-pick -s [BRANCHNAME]
- If more than one:
git cherry-pick -s [BRANCHNAME]~[Number of commits]..[BRANCHNAME]
(for example, if you are bringing in two commits from the survey-docs branch, rungit cherry-pick survey-docs~2..survey-docs)
- Test build the changed AsciiDoc file + the nav.adoc file(s) that include it
perl ./generate_docs.pl --base-url http://examplesite.org/prod
- Check to see if there are any images posted to the Github conversation that have not been committed yet. Add those to
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 make sure everything looks good.- Make sure that the commit message begins with "Docs:"
- Make sure the commit message includes the relevant Launchpad bug number
- 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
git checkout rel_3_8
- If one commit:
git cherry-pick master
- If more than one:
git cherry-pick master~[Number of commits]..master
- Go back to the pull request on Github's site. Comment on the pull request to thank the contributor, then close the pull request.
evergreen-docs/github-workflow.1622241353.txt.gz · Last modified: 2022/02/10 13:34 (external edit)