Versions Compared

Old Version 26

changes.mady.by.user Sean Broeder

Saved on

compared with

New Version 27

changes.mady.by.user Steve Varnau

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

    Code Block
    languagebash
    unset SSH_ASKPASS


  • Pushing code to the Apache repository requires password authentication.

  • Ensure that your work space is cloned from GitHub:

    Code Block
    languagebash
    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.)

    Code Block
    languagebash
    git remote add apache https://USERNAME@git-wip-usUSERNAME@gitbox.apache.org/repos/asf/trafodion.git


...

Be Aware of Licensing Concerns

Trafodion is developed and provided using the Apache 2.0 license. In order to not compromise that license, we must be careful about accepting code contributions that are not original code. We cannot accept code forked from other open source projects that have a non-permissive license for example.

 

If a reviewer suspects that contributed code is not original without attribution, the reviewer should -1 the change, and in the review comment, state the concern about originality and licensing. If the contributed code is proven to be unoriginal and with an incompatible license, the contribution should be rejected. If this happens, it is recommended that the Trafodion PPMC privately discuss with the contributor the importance of proper licensing and proper attribution or originality. The importance of attribution, originality, and licensing is often difficult for some new contributors, for some students, and for some people from various cultures of origin, and this should be seen as a learning and teaching opportunity.

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 


Note
titleTarget Branch

Before beginning, make careful note of what branch you are merging to. At the top of the pull request, you'll see words like, "So-and-so wants to merge n commits into apache:target_branch from github_user:some_other_branch. Most of the time, target_branch will be "master", but occasionally you'll see a release branch instead, e.g., "release1.3". In the instructions below, if the target_branch is not "master", replace "master" with the name of the target branch.

...

StepmaindocsapidocsDescriptionCommand
1XXXGet the Trafodion source code from gitsee "Download and Install Source"
2 XXCheck out a specific release X.Y.Z, if you want to update the documentation for a previous release
git checkout rel/X.Y.Z
3XX Build Trafodion site & documentation, after modifications to the documents, see Modifying Documents.
cd trafodion
source env.sh
mvn post-site 
4  XBuild Trafodionsee "Build Source"
5XXXGet the web site content from git
git clone https://ApacheUserName@git-wip-usApacheUserName@gitbox.apache.org/repos/asf/trafodion-site.git
cd trafodion-site
git checkout -b asf-site origin/asf-site
6XX Copy built web/doc changes to main site. This should be done from the master branch (release branch while a release is in progress) ONLY. This should not over-write release-specific docs.

see "Modify Web Site"

cp -R trafodion/docs/target/*   trafodion-site/
7 X Copy the release-specific built documentation. This is for non-master branches.
cp -R trafodion/docs/target/docs/<release>   trafodion-site/docs/
8  XBuild apidocs (note: X.Y.Z is the release number, see step 2 above). TBD: Instructions for copying apidocs to site repository.
cd trafodion-site/apidocs
build_apidocs.sh -o X.Y.Z
9XXXCommit changes in the web site repository
git status
git add --all
git commit 
10XXXPush changes back to ASF repository
git push origin HEAD:asf-site
11XXXCheck that the website, http://trafodion.apache.org is refreshed. If it isn't, make a small white-space change to the index.html file to trigger the Apache gitpubsub that does the update. 
12X  Once published, run https://validator.w3.org against updated pages to ensure that there are no broken links 
13XXXClose the JIRA and/or pull request, if applicable 

...