User Tools

Site Tools


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:

  1. git pull https://github.com/[GIT_USER]/Evergreen patch-[number] (where patch-[number] is the branch name)
  2. git fetch origin && git rebase origin/master
  3. 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
  4. Make any corrections (via additional commits, if needed)
  5. Sign off on each commit: git cherry-pick -s [commit-hash] or git 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
  6. When you are confident your commits are ready: git push origin master
  7. Backport to previous EG versions as appropriate
  8. Email docs list and/or pull requester to say it is done (or with other feedback)
  9. Close pull request on GitHub
evergreen-docs/github-workflow.1412107042.txt.gz · Last modified: 2022/02/10 13:34 (external edit)

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.