If you are a Java Developer and interested in contributing to Apache Ranger Project ?
Download the Apache Ranger Project
You should be able to pull the Apache Ranger code into your local machine.
git clone https://gitbox.apache.org/repos/asf/ranger.git
Alternatively, the git repo is automatically mirrored on Github at: https://github.com/apache/ranger
You can fork that repository, commit changes to your fork, and submit Pull requests (PR) through GitHub's pull request mechanisms. Beware that Apache Ranger project uses ReviewsBoard primarily! See p.8 below for more information!
PRs are still useful for contributors because the PRs trigger builds at TravisCI on Linux x86_64 and ARM64 CPU architectures. If the CI build is successful then it is recommended to create a review request at ReviewBoard by using the patch generated by https://github.com/apache/ranger/pull/<PR_NUMBER>.patch (replace <PR_NUMBER> with the number of your Pull Request!)
You can find the ways to build and deploy the code from Quick Start Guide. You can get further information about Apache Ranger from the Project Home Page.
Subscribe to Apache Ranger Development Community
Also, Developer mailing list is a good resource for gaining knowledge about the current features being discussed/designed for the release.
You can subscribe to developer mailing list by sending mail to dev-subscribe@ranger.apache.org
Are you ready to work on some code ?
If you are new person to Apache, please create a new account from Apache Self-Service Jira Account Creation page. Once you have a valid Apache JIRA user account,
- Login into JIRA Page for Apache Ranger
- Review all unassigned JIRA(s) that are of your interest and pick a JIRA to work on.
- Send a note to dev community via dev@ranger.apache.org to have a PMC member assign the JIRA to you.
- Once the JIRA is assigned to you, you can work on the Apache Ranger source on your local repo - to resolve the JIRA.
- Configure your git to use your username and email address. So when the patch is created, it will have your information and the code will have your credit.
After the JIRA is resolved, you can commit the changes to your local repo with commit comment with Apache JIRA number as follows:
$ git add <modified|add|deleted-files> $ git commit -m "RANGER-<JIRANUMBER>: <description of the JIRA fix>"
After you committed your change into your local repo, you should be able to create a patch using the following command:
$ git format-patch -n HEAD~
This command should create a git patch file under the current directory. Attach the patch file to the Apache JIRA and provide your comment about the solution. An Apache Ranger committer should be able to review your patch and provide feedback or commit to Apache Ranger.
If you have issues applying the patch correctly, please do the following:
git config diff.noprefix false
For additional information, please refer to discussions in RANGER-1739
You should upload the patch in https://reviews.apache.org/r/. Steps are:
Create an account in review board
Click on "New Review Request"
Search for "ranger" in the repository at the left
Upload your patch file
Give name and description. Add Apache JIRA # in review request title/name
- On the right side, give the JIRA number, select group "ranger"
- And publish the request.
- Attach the patch to Apache JIRA
- Provide the link to the review request in Apache JIRA
- Mark the fix version appropriately (if you know)
- If the patch is accepted, then one of the committers will commit your code.
- Update the JIRA with commit link once the patch is reviewed and committed
- Mark the review request as closed once the patch is committed
For pulling latest source changes from Apache Ranger, you can execute the following command to get latest code changes from remote Apache repo to your local repo:
$ git pull
FOR COMMITTERS: Those committing contributed code, please follow the below processafterapproving the code
#Test whether the patch can be applied without errors git apply --check RANGER-xyz.patch #Apply the patch git am --signoff RANGER-xyz.patch #Push the changes git push
VOTE for an Apache Ranger Release
To VOTE for an Apache Ranger Release, You should be subscribed to dev mailing list of Apache Ranger. You can subscribe to developer mailing list by sending mail to dev-subscribe@ranger.apache.org
Once you have the VOTE email from a Release Manager, you can do the following to validate the Apache RANGER release:
- Download all artifacts specified in the release email (e.g: apache-ranger-${RANGER_RELEASE}.tar.gz )
- Download the PGP Signature file associated with the release artifact (eg: apache-ranger-${RANGER_RELEASE}.tar.gz.asc)
- Download the SHA256 Signature file associated with the release artifact (eg: apache-ranger-${RANGER_RELEASE}.tar.gz.sha256)
- Download the SHA512 Signature file associated with the release artifact (eg: apache-ranger-${RANGER_RELEASE}.tar.gz.asc.sha51)
Run the following commands to validate the ranger build:
Apache buildRANGER_RELEASE=X.X.X # PLEASE define your RELEASE number such as 2.2.0 .... tar xf apache-ranger-${RANGER_RELEASE}.tar.gz cd apache-ranger-${RANGER_RELEASE} mvn -Pall -DskipTests=false clean compile package installRun the following commands to validate the ranger release artifacts:
Validate Release Artifacts# Go to the directory where the artifact is downloaded gpg --import KEYS gpg --verify apache-ranger-${RANGER_RELEASE}.tar.gz.asc apache-ranger-${RANGER_RELEASE}.tar.gz gpg --print-mds apache-ranger-${RANGER_RELEASE}.tar.gz # Validate the SHA256 and SHA512 Signatures with the content of file below ... cat apache-ranger-${RANGER_RELEASE}.tar.gz.sha256 cat apache-ranger-${RANGER_RELEASE}.tar.gz.sha512- Once the validations are complete, please VOTE via email - replying to the original VOTE request using the process described in Apache VOTING Process.
If you have any questions related to Apache Ranger development questions, please feel free to contact dev group via email - dev@ranger.apache.org .