You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by bu...@apache.org on 2014/10/16 14:39:44 UTC
svn commit: r925950 - in /websites/staging/isis/trunk: cgi-bin/ content/
content/contributors/ content/contributors/resources/
Author: buildbot
Date: Thu Oct 16 12:39:44 2014
New Revision: 925950
Log:
Staging update by buildbot for isis
Modified:
websites/staging/isis/trunk/cgi-bin/ (props changed)
websites/staging/isis/trunk/content/ (props changed)
websites/staging/isis/trunk/content/contributors/contributing.html
websites/staging/isis/trunk/content/contributors/resources/git-workflow.png
websites/staging/isis/trunk/content/contributors/resources/git-workflow.pptx
websites/staging/isis/trunk/content/contributors/resources/verify-isis-release.sh
Propchange: websites/staging/isis/trunk/cgi-bin/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Oct 16 12:39:44 2014
@@ -1 +1 @@
-1632262
+1632288
Propchange: websites/staging/isis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Oct 16 12:39:44 2014
@@ -1 +1 @@
-1632262
+1632288
Modified: websites/staging/isis/trunk/content/contributors/contributing.html
==============================================================================
--- websites/staging/isis/trunk/content/contributors/contributing.html (original)
+++ websites/staging/isis/trunk/content/contributors/contributing.html Thu Oct 16 12:39:44 2014
@@ -427,7 +427,7 @@
<p>Thanks for considering to help out, your contributions are appreciated!</p>
-<h2>Workflow</h2>
+<h2>Recommended Workflow (github pull requests)</h2>
<p>Isis' source code is hosted in an Apache git repo (<a href="https://git-wip-us.apache.org/repos/asf/isis.git">https</a>, <a href="http://git-wip-us.apache.org/repos/asf/isis.git">http</a>), with a clone on github (<a href="https://github.com/apache/isis.git">https</a>, or ssh: <code>git@github.com:apache/isis.git</code>.</p>
@@ -439,7 +439,7 @@
<p>That is:</p>
-<ul>
+<ol>
<li>as a one-time activity, you fork the <a href="https://github.com/apache/isis.git">github.com/apache/isis</a> repo into your own fork on github.com</li>
<li>as a one-time activity, you clone your fork to your local computer</li>
<li>you set the <a href="https://github.com/apache/isis.git">github.com/apache/isis</a> as your upstream branch; this will allow you to keep your local clone up-to-date with new commits
@@ -447,13 +447,14 @@
<li>note the asymmetry here: the <code>upstream</code> repo (the Apache github repo) is <strong>not</strong> the same as the <code>origin</code> repo (your fork).</li>
</ul></li>
<li>you work on your changes locally; when done, you push them to your github fork</li>
-</ul>
+<li>to contribute back a change, raise a <a href="https://issues.apache.org/jira/browse/ISIS">JIRA</a> ticket, and ensure your commit message is in the form: <code>ISIS-nnnn: ...</code> so that changes can be tracked (more discussion on this point below). In any case, before you decide to start hacking with Isis, it's always worth creating a ticket in JIRA and then have a discussion about it on the <a href="http://isis.apache.org/support.html">mailing lists</a>. </li>
+<li>Use github to raise a <a href="https://help.github.com/articles/using-pull-requests/">pull request</a> for your feature</li>
+<li>An Isis committer will review your change, and apply it if suitable.</li>
+</ol>
-<p>The diagram also indicates the <a href="https://issues.apache.org/jira/browse/ISIS">JIRA</a> ticket; all work in Isis should tracked in JIRA. Before you decide to start hacking with Isis, it's always worth creating a ticket in JIRA and then have a discussion about it on the <a href="http://isis.apache.org/support.html">mailing lists</a>. </p>
+<h2>Alternative Workflow (JIRA patches)</h2>
-<p>Assuming you have a JIRA ticket, generally speaking all you need to do once you have your patch is to add a comment with the URL to your patch on your github fork; the Isis committer can then download your patch from the JIRA ticket, review it, and apply your patch. </p>
-
-<p>As a slight simplification to the above, you may decide to clone directly from <a href="https://github.com/apache/isis.git">github.com/apache/isis</a> rather than create your own fork:</p>
+<p>As an alternative, you may decide to clone directly from <a href="https://github.com/apache/isis.git">github.com/apache/isis</a> rather than create your own fork:</p>
<p><img src="resources/git-workflow-2.png" width="600px"></img></p>
@@ -461,7 +462,7 @@
<p>For the Isis committers it really doesn't matter which route you take, so go with whatever's most comfortable.</p>
-<h3>Setting up your fork/clone</h3>
+<h2>Setting up your fork/clone</h2>
<p>If you choose to create your own fork then you'll need an account on <a href="https://github.com">github.com</a>. You then fork simply by pressing the "Fork" button:</p>
@@ -520,9 +521,7 @@ why this is a problem, and how the patch
<h2>Creating the patch file</h2>
-<p>If you are working off your own github fork, then you can use github to generate your patch files. Attach them to the relevant JIRA.</p>
-
-<p>If you are working without a github fork, then you can create the patches from your own local git repository.</p>
+<p>If you are working without a github fork of Isis, then you can create the patches from your own local git repository.</p>
<p>As per <a href="http://stackoverflow.com/questions/6658313/generate-a-git-patch-for-a-specific-commit">this stackoverflow question</a>, create the patch using <code>git format-patch</code>:</p>
@@ -535,7 +534,7 @@ why this is a problem, and how the patch
<p>Assuming you're development environment is all setup, let's walk through how you might make contribute a patch. In this example, suppose that you've decided to work on JIRA ticket #123, an enhancement to support Blob/Clob datatypes.</p>
-<h3>Update your master branch</h3>
+<h4>Update your master branch</h4>
<p>The first thing to do is to make sure your local clone is up-to-date. We do this by retrieving new commits from upstream repo and then merging them as a fast-forward into your local branch.</p>
@@ -556,7 +555,7 @@ git pull --ff-only
<p>If the <code>merge</code> or <code>pull</code> fails, it means that you must have made commits and there have been changes meanwhile on the remote <code>master</code>'s branch. You can use <code>gitk --all</code> to confirm. If this fails, see our <a href="git-cookbook.html">git cookbook</a> page for a procedure to retrospectively sort out this situation.</p>
-<h3>Create a topic branch</h3>
+<h4>Create a topic branch</h4>
<p>We recommend you name topic branches by the JIRA ticket, ie <tt>ISIS-nnn-description</tt>. So let's create a new branch based off <code>master</code> and call it "ISIS-123-blobs"</p>
@@ -575,7 +574,7 @@ master
<p>The command line prompt should also indicate you are on a branch, isolated from any changes that might happen on the <code>master</code> branch.</p>
-<h3>Make File Changes and Commit</h3>
+<h4>Make File Changes and Commit</h4>
<p>Next, make changes to your files using the usual commands (see also our <a href="git-cookbook.html">git cookbook</a> page):</p>
@@ -591,9 +590,9 @@ master
<p>Continue this way until happy with the change. Remember to run all your tests on the topic branch (including a full <code>mvn clean install</code>).</p>
-<h3>Reintegrating with <code>master</code></h3>
+<h4>Rebasing with <code>master</code></h4>
-<p>Before you can share your change, you should reintegrate your changes with the <code>master</code> branch. </p>
+<p>Before you can share your change, you should rebase (in other words replay) your changes on top of the <code>master</code> branch. </p>
<p>The first thing to do is to pull down any changes made in upstream remote's <code>master</code> since you started your topic branch:</p>
@@ -622,7 +621,7 @@ git rebase --continue
<p>Once the rebase has completed, re-run your tests to confirm that everything is still good.</p>
-<h3>Making your change available remotely (with fork)</h3>
+<h4>Raising a pull request</h4>
<p>If you have your own fork, you can now simply push the changes you've made locally to your fork:</p>
@@ -633,11 +632,9 @@ git push -u origin ISIS-123-blobs
<p>This will create a corresponding branch in the remote github repo. If you use <code>gitk --all</code>, you'll also see a <code>remotes/origin/ISIS-123-blobs</code> branch.</p>
-<p>Then, update your JIRA and add a comment with a URL to this branch.</p>
+<p>Then, use github to raise a <a href="https://help.github.com/articles/using-pull-requests/">pull request</a>. Pull requests sent to the Apache GitHub repositories will forward a pull request e-mail to the <a href="../support.html">dev mailing list</a>. You'll probably want to sign up to the dev mailing list first before issuing your first pull request (though that isn't mandatory).</p>
-<p>You can aso use github to raise a <em>pull request</em>. Pull requests sent to the Apache GitHub repositories will forward a pull request e-mail to the <a href="../support.html">dev mailing list</a>; sign up to the dev mailing list first before issuing your pull request.</p>
-
-<p>The process to raise the pull request:</p>
+<p>The process to raise the pull request, broadly speaking:</p>
<ul>
<li>Open a web browser to your github fork of isis</li>
@@ -646,10 +643,6 @@ git push -u origin ISIS-123-blobs
<li>Check that the Isis mailing list email came through.</li>
</ul>
-<h3>Making your change available remotely (no fork)</h3>
-
-<p>If you decided against having your own github fork, then you'll need to create a patch and then attach to the JIRA. Use <code>github diff</code> and redirect to a file.</p>
-
<h2>If your pull request is accepted</h2>
<p>To double check that your pull request is accepted, update your <code>master</code> branch from the <code>upstream</code> remote:</p>
Modified: websites/staging/isis/trunk/content/contributors/resources/git-workflow.png
==============================================================================
Binary files - no diff available.
Modified: websites/staging/isis/trunk/content/contributors/resources/git-workflow.pptx
==============================================================================
Binary files - no diff available.
Modified: websites/staging/isis/trunk/content/contributors/resources/verify-isis-release.sh
==============================================================================
--- websites/staging/isis/trunk/content/contributors/resources/verify-isis-release.sh (original)
+++ websites/staging/isis/trunk/content/contributors/resources/verify-isis-release.sh Thu Oct 16 12:39:44 2014
@@ -1,52 +1,52 @@
-#!/bin/bash
-# Instructions:
-# -Create an empty directory
-# -Put a .txt file in it containing a list of all the urls of the zip files
-# -Run this script
-# TODO: enhance this script so it will stop when something is broken
-_download(){
- for fil in `cat *.txt`
- do
- echo 'Downloading '$fil
- curl -L -O $fil
- curl -L -O $fil.asc
- done
-}
-_verify(){
- for zip in *.zip
- do
- echo 'Verifying '$zip
- gpg --verify $zip.asc $zip
- done
-}
-_unpack(){
- echo 'Unpacking '
- unzip -q '*.zip'
-}
-_build(){
- echo 'Removing Isis from local repo '$module
- rm -rf ~/.m2/repository/org/apache/isis
- COUNTER=0
- for module in ./*/
- do
- COUNTER=$[COUNTER+1]
- if [ $COUNTER -eq 1 ]
- then
- cd $module
- echo 'Building Core '$module
- mvn clean install -o
- cd ..
- else
- cd $module
- echo 'Building Module '$module
- mvn clean install
- cd ..
- fi
- done
-}
-# The work starts here
-_download
-_verify
-_unpack
-_build
-
+#!/bin/bash
+# Instructions:
+# -Create an empty directory
+# -Put a .txt file in it containing a list of all the urls of the zip files
+# -Run this script
+# TODO: enhance this script so it will stop when something is broken
+_download(){
+ for fil in `cat *.txt`
+ do
+ echo 'Downloading '$fil
+ curl -L -O $fil
+ curl -L -O $fil.asc
+ done
+}
+_verify(){
+ for zip in *.zip
+ do
+ echo 'Verifying '$zip
+ gpg --verify $zip.asc $zip
+ done
+}
+_unpack(){
+ echo 'Unpacking '
+ unzip -q '*.zip'
+}
+_build(){
+ echo 'Removing Isis from local repo '$module
+ rm -rf ~/.m2/repository/org/apache/isis
+ COUNTER=0
+ for module in ./*/
+ do
+ COUNTER=$[COUNTER+1]
+ if [ $COUNTER -eq 1 ]
+ then
+ cd $module
+ echo 'Building Core '$module
+ mvn clean install -o
+ cd ..
+ else
+ cd $module
+ echo 'Building Module '$module
+ mvn clean install
+ cd ..
+ fi
+ done
+}
+# The work starts here
+_download
+_verify
+_unpack
+_build
+