Merge Changes

Provides information describing how a committer reviews and approves pull requests.

Initial Set-Up

Step 1: Configure git E-Mail

Configure git to use your Apache e-mail address.

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

Alternatively, you can edit your .gitconfig file so that you don't need to enter the commands interactively by adding

[user]
name = myusername
email = myusername@apache.org

Step 2: Check trafodion-contributors Group

Step 3: Set Up Work Space

• In VNC/Gnome environment, either add to .bashrc or type at your current shell:

  unset SSH_ASKPASS

  
  

• Pushing code to the Apache repository requires password authentication.

• Ensure that your work space is cloned from GitHub:

  git clone https://github.com/apache/trafodion

• Ensure that you have a remote pointing to the Apache repository. (Setting only the push URL with user name does not seem to work. This means that fetching the apache remote prompts for a password, but it is ignored. You can hit return without entering password, and fetch still works! You must enter password only when pushing to apache remote.)

  git remote add apache https://USERNAME@gitbox.apache.org/repos/asf/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.

Validate Review Criteria

Guidelines for Code Reviews 

Merge Pull Requests - The Easy Way

The easy way is to the click the big green button on github that says "Merge Pull Request".

However, in order for committers to have that write-access via github, they must have your apache ID linked to their github ID.  Follow directions at: https://gitbox.apache.org/setup/

Merge Pull Requests - The Hard Way 

Step 1: Check Status

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.

Step 2: Create Local Merge Branch

Create a local merge branch, based on the latest, greatest.

# You will be prompted for password, but you do not have to enter it for fetch. Just hit return.
git fetch apache
git checkout -b mrg_12345 apache/master

Step 3: Fetch Pull Request Branch

Fetch pull request branch to default destination FETCH_HEAD.

git fetch origin +refs/pull/12345/head

Step 4: Merge Locally

Merge locally, giving message that includes JIRA ID.

git merge --no-ff -m "Merge [TRAFODION-XYZ] PR-12345 Whizbang feature" FETCH_HEAD
 OR
git merge --squash FETCH_HEAD
git commit  # edit comment, give good headline and detailed body
            # Also include phrase "This closes #<PR num>" substituting in the pull-request number

NOTES

• Sometimes for changes with many commits, you might want to squash their branch into a single commit. If so, add the --squash option.
  • On the plus side, squashing a developer branch into single commit puts all the file related changes into a single commit. Easier to find, back-port, etc.
  • On the minus side, squashing breaks the change from the developer history. Be extra careful to edit the comment to clearly identify the developer and combined commit comments. 
• If you forget the -m option, you end up with a less than helpful default comment.

  • Before you push the commit, you can fix the comment by:

    git commit --amend

Step 5: Additional Checks

Additional checks of what you are preparing to push.

git log apache/master..HEAD
git diff apache/master HEAD

Step 6: Push Changes

Push changes to the Apache repository, specifying the source and the destination branch.

# You will be prompted for your Apache password
git push apache HEAD:master

Publish Web Site Updates

There are three main types of content on the Apache Trafodion web site:

• The main site content
• Trafodion documents, generated from the Trafodion source code
• Trafodion apidocs, generated from the Trafodion source code and built objects

Depending on which type of content you want to update, you will need to include different steps of the instructions shown below, required steps are marked with an X:

git checkout rel/X.Y.Z

cd trafodion
source env.sh
mvn post-site 

git clone https://ApacheUserName@gitbox.apache.org/repos/asf/trafodion-site.git
cd trafodion-site
git checkout -b asf-site origin/asf-site

cp -R trafodion/docs/target/*   trafodion-site/

cp -R trafodion/docs/target/docs/<release>   trafodion-site/docs/

cd trafodion-site/apidocs
build_apidocs.sh -o X.Y.Z

git status
git add --all
git commit 

git push origin HEAD:asf-site