User Tools

Site Tools


evergreen-docs:github-workflow

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
evergreen-docs:github-workflow [2018/02/06 10:40] rjs7evergreen-docs:github-workflow [2020/08/18 10:53] aneiman
Line 12: Line 12:
     - ''git checkout [BRANCHNAME]''     - ''git checkout [BRANCHNAME]''
   - Rebase the pull request branch to master, and handle any conflicts   - Rebase the pull request branch to master, and handle any conflicts
-    - ''git rebase master''+    - ''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''
   - Test build the changed AsciiDoc file + the root*.adoc files that include it   - Test build the changed AsciiDoc file + the root*.adoc files that include it
     * ''asciidoc -a icons -a toc -d book -o OUTPUT_FILE ASCIIDOC_FILE''     * ''asciidoc -a icons -a toc -d book -o OUTPUT_FILE ASCIIDOC_FILE''
Line 20: Line 20:
     * 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 ''git log'' to retrieve commit IDs
   - Use interactive rebase to add the commits to your local master, adding your sign-off   - Use interactive rebase to add the commits to your local master, adding your sign-off
     - ''git checkout master''     - ''git checkout master''
-    - ''git rebase -[BRANCH_NAME]^'' (note the caret!)+    - ''git cherry-pick [commit ID]''
       * Include the relevant Launchpad bug number somewhere in the commit message       * Include the relevant Launchpad bug number somewhere in the commit message
         * Example: "Resolves LP#1234567"         * Example: "Resolves LP#1234567"
-      * 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's identity in git.evergreen-ils.org, consider fixing it with ''%%git commit --amend --author="NAME <email>"%%'')       * (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''   - When you are confident your local master branch is ready: ''git push origin master''
evergreen-docs/github-workflow.txt · Last modified: 2023/12/28 15:54 by aneiman

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.