You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Documents a basic overview of how we develop Trafodion.

Working in Git

Install Git Tools

You use git to make changes to the Trafodion code, tests, documentation, and web site:

Git Cheat Sheet

For future reference, the git commands used below are summarized in Git Cheatsheet in the How-To chapter.

Download Trafodion Source Tree

You download the Trafodion source tree once the git tools have been installed.

Fork Trafodion Repository

You create a private fork of Trafodion on https://github.com/apache/incubator-trafodion. Use the fork button top-right on the page to create your fork, which will be named <your-git-id>_fork.

 

The following examples use trafdeveloper to represent <your-git-id>.

Clone Trafodion Repository

Use the git shell to perform this task.

Clone Trafodion Repository
# Move to the directory where you want to install the Trafodion source code.
cd mysource

# Clone the Trafodion source code
git clone git://git.apache.org/incubator-trafodion.git

# Change to the Trafodion source-tree directory
cd incubator-trafodion
 
# Register your fork as a remote branch
git remote add trafdeveloper_fork git@github.com:trafdeveloper/incubator-trafodion

At this point, you’ve finished all preparation steps. Now, you can start making changes.

Make Changes

Create Task Branch

You create a task branch to make changes to the Trafodion source tree. Typically, we name the branches after the Jira we are working on. In this example, the Jira is: TRAFODION-1507.

Create Task Branch
# Ensure that you have the latest changes
git fetch --all

# Checkout source
git checkout -b TRAFODION-1507 origin/master   # or origin/releaseX.Y for a release patch

Change Recipes

How to make changes depends on what part of the source tree you are working on. Please refer to the following chapters:

Change TypeRefer To...
CodeModify Code
QA TestsModify Tests
DocumentationModify Documentation
Web SiteModify Web Site

Commit Changes 

Run Regression Tests

If you’re making code changes, then ensure that you run the Regression Tests before committing changes.

Perform the following steps to commit your changes. 

Commit Changes
# Commit changes
git commit -a

# Dry-run check against main branch
git push -n trafdeveloper_fork HEAD

# Push changes to your private fork
git push trafdeveloper_fork TRAFODION-1507

Create Pull Request

Your changes need to be reviewed by a Trafodion committer. Therefore, you need to create a pull request for your private repository.

The Trafodion Automated Tests are triggered to run on every pull request. These tests take 1-2 hours to run. Shorter tests run if you've changed only documentation or the web site. Please refer to Automated Tests for information about how to check the outcome of these tests.

Using GitHub Web Site (Preferred)

Do the following: 

  1.  Go to https://github.com/apache/incubator-trafodion. 
  2. Click the green Create Pull Request button. 
  3. Review changes one more time before clicking Create Pull Request.

 

Please refer to https://help.github.com/articles/creating-a-pull-request/ for more documentation.

Using Git Command Line (with Hub extension) 

Do the following:

Git Bash Pull Request
# Generate pull request
git pull-request

Ensure that you include the Jira ID at the beginning of the title in your pull request. For example: [TRAFODION-1507] Explanation of the changes you made.

Review Comments

The pull request gets reviewed by the committers and other contributors. Once you get a consensus, the committer merges your changes into the target incubator-trafodion branch. Check your e-mail for comments.

Address Review Comments

Follow the GitHub conversation on your pull request (you should be automatically subscribed). Respond to questions and issues.

 If you need to make additional changes, then do the following (the example below uses a sample Jira ID):

  1. Check out the code: git checkout TRAFODION-1507
  2. Make the requested changes.
  3. Run regression tests, if applicable.
  4. Commit the changes with appropriate change information: git commit -a
  5. Push the changes back to your private git fork: git push trafdeveloper_fork TRAFODION-1507

The push command automatically adds the change to the active pull request.

Do not use the git commit --amend or git rebase command after pushing a commit.

Change Merge

If all is well, a committer will merge your change into the Apache repository, which is mirrored on GitHub. You may be asked to close out the JIRA or other follow up.

Your change is done. Thanks for your contribution to Trafodion.

Where To Go From Here

You should have a basic understanding of how Trafodion is developed at this point. Where you go next depends on what areas you intend to contribute to:

  • Create Build Environment: Trafodion requires a number of Linux packages and tools before you can build the code. This step is required if you intend to work on the Trafodion source or test code. It’s not strictly needed if you intend to work on the Trafodion documentation or web site; you can build these components without the complete Trafodion Build Environment. Refer to Modify Documentation or Modify Web Site.

  • Build Source: You can build the Trafodion source once the Build Environment has been created. Several options are available, including the capability to build the Trafodion binaries.

    You MUST create the Build Environment before Building the Source.

  • Create Test Environment: You need to set up the Trafodion test environment in order to run the different Trafodion test libraries. You need to set up an Hadoop environment to test Trafodion. Trafodion includes scripts to create a small Hadoop environment, if needed.

    You MUST create the Build Environment before creating the Test Environment.

This step is not necessary if you just want to build a Trafodion binary or if you working on the Documentation and/or Web Site.

  • Modify Documentation: You can modify the Trafodion documentation without creating the Trafodion Build Environment or Trafodion Test Environment. Typically, contributors working on the Trafodion code also modify the Trafodion Documentation when making changes.

  • Modify Web Site: You can modify the Trafodion web site without creating the Trafodion Build Environment or Trafodion Test Environment.

  • No labels