Committer Workflow

For project committers merging changes into git repo

Committer Process

See also, Apache page: https://git-wip-us.apache.org/

Initial Set-up

Be sure to use your apache address.

• git config --global user.email myusername@apache.org

Check that your github user is a public member in the "trafodion-contributors" group. This allows some permissions with the Jenkins test server.

• https://github.com/orgs/trafodion-contributors/people

Workspace set-up for merging pull requests.

1. In the VNC/Gnome environment, either add to your .bashrc or type in your current shell unset SSH_ASKPASS
2. Make sure you have set up your SSH key in Apache account
   • http://www.apache.org/dev/new-committers-guide.html#ssh-setup
   • Alternatively, you can use your username/password
3. Make sure you have a workspace cloned from github.
   • git clone https://github.com/apache/incubator-trafodion
4. Make sure you have a remote pointing to the Apache repo.
   • Using SSH:
     • git remote add apache https://git-wip-us.apache.org/repos/asf/incubator-trafodion.git
   • OR using password access:
     • git remote add apache https://USERNAME@git-wip-us.apache.org/repos/asf/incubator-trafodion.git

Automated Testing

You can interact with Jenkins testing via pull request (PR) comments. All of these commands should start with "jenkins," to not confuse other users. You can add more to the end of the message if you want. Jenkins just pattern matches the string, and will ignore trailing comments.

• If an unknown user submits a PR, then Jenkins automation will post a message to github asking if it is okay to test.
  • Review the pull request. If the code is not malicious and is okay to test, post a comment "jenkins, ok"
• If the author is a trusted contributor, you can add them to a white-list of known users.
  • Post a comment "jenkins, add user"
  • Consider inviting them to the "trafodion-contributors" github group as well.
• New commits to the PR will trigger a new build. You can also trigger a retest without a new commit.
  • Post a comment "jenkins, retest"

Ensure Criteria are Met

The acceptance criteria are determined by the project committee (PPMC). They should be documented here.

• Code Review(s)
• Time available for comments
• Testing
• Legal
• Other

Merge Pull Request

Example of merging pull request 12345.

1. Check the pull request status on github, at the bottom of the pull request page. It will tell you if there are any merge conflicts with master branch.
   1. If there are conflicts, either ask the contributor to merge up, or be prepared to resolve the conflicts yourself.
2. Create a local merge branch, based on the latest, greatest.
   1. git fetch apache (if ssh is not setup you will be prompted for your apache password)
   2. git checkout -b mrg_12345 apache/master
3. Fetch pull request branch to default destination FETCH_HEAD
   • git fetch origin +refs/pull/12345/head
4. Merge locally, giving message that includes JIRA IDNormally, you want to just merge their branch:
   • git merge --no-ff -m "Merge [TRAFODION-XYZ] PR-12345 Whizbang feature" FETCH_HEAD
   • Sometimes you might want to squash their branch into a single commit. If so, add the "--squash" option.
5. Additional checks of what you are preparing to push
   • git log apache/master..HEAD
   • git diff apache/master HEAD
6. Push changes to Apache repo, specifying the source and the destination branch.
   • git push apache HEAD:master (if ssh is not setup you will be prompted for your apache password)

Completion

1. Close Jira, if appropriate, or ask the contributor to do so.
2. If ASF automation does not close the pull request, ask the contributor to do so.

Related articles appear here based on the labels you select. Click to edit the macro and add or change labels.Related articles