You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by da...@apache.org on 2016/11/22 01:03:47 UTC
[1/3] incubator-beam-site git commit: Update download page to specify
backward-compatibility guarantees
Repository: incubator-beam-site
Updated Branches:
refs/heads/asf-site 0c4bff77b -> 60791ca2e
Update download page to specify backward-compatibility guarantees
Project: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/commit/7f7a8b2d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/tree/7f7a8b2d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/diff/7f7a8b2d
Branch: refs/heads/asf-site
Commit: 7f7a8b2d3e8672516627b6949d0cbafa44e13fc5
Parents: 0c4bff7
Author: Davor Bonaci <da...@google.com>
Authored: Mon Nov 21 13:36:18 2016 -0800
Committer: Davor Bonaci <da...@google.com>
Committed: Mon Nov 21 17:03:12 2016 -0800
----------------------------------------------------------------------
src/get-started/downloads.md | 27 ++++++++++++++++++++-------
1 file changed, 20 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/7f7a8b2d/src/get-started/downloads.md
----------------------------------------------------------------------
diff --git a/src/get-started/downloads.md b/src/get-started/downloads.md
index 0015d77..af8506a 100644
--- a/src/get-started/downloads.md
+++ b/src/get-started/downloads.md
@@ -33,19 +33,32 @@ Additionally, you may want to depend on additional SDK modules, such as IO
connectors or other extensions, and additional runners to execute your pipeline
at scale.
-## Release Notes
+## API Stability
+
+Apache Beam uses [semantic versioning](http://semver.org/). Version numbers use the form `major.minor.incremental` and are incremented as follows:
+
+* major version for incompatible API changes
+* minor version for new functionality added in a backward-compatible manner
+* incremental version for forward-compatible bug fixes
+
+Please note that APIs marked [`@Experimental`]({{ site.baseurl }}/documentation/sdks/javadoc/{{ site.release_latest }}/org/apache/beam/sdk/annotations/Experimental.html)
+may change at any point and are not guaranteed to remain compatible across versions.
+
+Additionally, any API may change before the first stable release, i.e., between versions denoted `0.x.y`.
+
+## Releases
### 0.3.0-incubating
-[Source code download](https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.3.0-incubating/apache-beam-0.3.0-incubating-source-release.zip&action=download)
+Official [source code download](https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.3.0-incubating/apache-beam-0.3.0-incubating-source-release.zip&action=download).
-* Release notes are available [in JIRA](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12338051).
+[Release notes](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12338051).
### 0.2.0-incubating
-[Source code download](https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.2.0-incubating/apache-beam-0.2.0-incubating-source-release.zip&action=download)
+Official [source code download](https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.2.0-incubating/apache-beam-0.2.0-incubating-source-release.zip&action=download).
-* Release notes are available [in JIRA](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12335766).
+[Release notes](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12335766).
### 0.1.0-incubating
-[Source code download](https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.1.0-incubating/apache-beam-0.1.0-incubating-source-release.zip&action=download)
+Official [source code download](https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.1.0-incubating/apache-beam-0.1.0-incubating-source-release.zip&action=download).
-* The first incubating release of Apache Beam.
+The first incubating release of Apache Beam.
[3/3] incubator-beam-site git commit: This closes #92
Posted by da...@apache.org.
This closes #92
Project: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/commit/60791ca2
Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/tree/60791ca2
Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/diff/60791ca2
Branch: refs/heads/asf-site
Commit: 60791ca2eaec274d972f9f9d3ce4860392a7bf1b
Parents: 0c4bff7 b0f91e7
Author: Davor Bonaci <da...@google.com>
Authored: Mon Nov 21 17:03:28 2016 -0800
Committer: Davor Bonaci <da...@google.com>
Committed: Mon Nov 21 17:03:28 2016 -0800
----------------------------------------------------------------------
content/get-started/downloads/index.html | 33 +++++++++++++++++----------
src/get-started/downloads.md | 27 ++++++++++++++++------
2 files changed, 41 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
[2/3] incubator-beam-site git commit: Regenerate website
Posted by da...@apache.org.
Regenerate website
Project: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/commit/b0f91e7f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/tree/b0f91e7f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/diff/b0f91e7f
Branch: refs/heads/asf-site
Commit: b0f91e7f11ec514d233f8bccb632676e37093eaa
Parents: 7f7a8b2
Author: Davor Bonaci <da...@google.com>
Authored: Mon Nov 21 17:03:28 2016 -0800
Committer: Davor Bonaci <da...@google.com>
Committed: Mon Nov 21 17:03:28 2016 -0800
----------------------------------------------------------------------
content/get-started/downloads/index.html | 33 +++++++++++++++++----------
1 file changed, 21 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/b0f91e7f/content/get-started/downloads/index.html
----------------------------------------------------------------------
diff --git a/content/get-started/downloads/index.html b/content/get-started/downloads/index.html
index 5b89c96..0849509 100644
--- a/content/get-started/downloads/index.html
+++ b/content/get-started/downloads/index.html
@@ -167,28 +167,37 @@ Java with the <code class="highlighter-rouge">DirectRunner</code>, add the follo
connectors or other extensions, and additional runners to execute your pipeline
at scale.</p>
-<h2 id="release-notes">Release Notes</h2>
+<h2 id="api-stability">API Stability</h2>
-<h3 id="incubating">0.3.0-incubating</h3>
-<p><a href="https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.3.0-incubating/apache-beam-0.3.0-incubating-source-release.zip&action=download">Source code download</a></p>
+<p>Apache Beam uses <a href="http://semver.org/">semantic versioning</a>. Version numbers use the form <code class="highlighter-rouge">major.minor.incremental</code> and are incremented as follows:</p>
<ul>
- <li>Release notes are available <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12338051">in JIRA</a>.</li>
+ <li>major version for incompatible API changes</li>
+ <li>minor version for new functionality added in a backward-compatible manner</li>
+ <li>incremental version for forward-compatible bug fixes</li>
</ul>
+<p>Please note that APIs marked <a href="/documentation/sdks/javadoc/0.3.0-incubating/org/apache/beam/sdk/annotations/Experimental.html"><code class="highlighter-rouge">@Experimental</code></a>
+may change at any point and are not guaranteed to remain compatible across versions.</p>
+
+<p>Additionally, any API may change before the first stable release, i.e., between versions denoted <code class="highlighter-rouge">0.x.y</code>.</p>
+
+<h2 id="releases">Releases</h2>
+
+<h3 id="incubating">0.3.0-incubating</h3>
+<p>Official <a href="https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.3.0-incubating/apache-beam-0.3.0-incubating-source-release.zip&action=download">source code download</a>.</p>
+
+<p><a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12338051">Release notes</a>.</p>
+
<h3 id="incubating-1">0.2.0-incubating</h3>
-<p><a href="https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.2.0-incubating/apache-beam-0.2.0-incubating-source-release.zip&action=download">Source code download</a></p>
+<p>Official <a href="https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.2.0-incubating/apache-beam-0.2.0-incubating-source-release.zip&action=download">source code download</a>.</p>
-<ul>
- <li>Release notes are available <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12335766">in JIRA</a>.</li>
-</ul>
+<p><a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12335766">Release notes</a>.</p>
<h3 id="incubating-2">0.1.0-incubating</h3>
-<p><a href="https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.1.0-incubating/apache-beam-0.1.0-incubating-source-release.zip&action=download">Source code download</a></p>
+<p>Official <a href="https://www.apache.org/dyn/closer.cgi?filename=incubator/beam/0.1.0-incubating/apache-beam-0.1.0-incubating-source-release.zip&action=download">source code download</a>.</p>
-<ul>
- <li>The first incubating release of Apache Beam.</li>
-</ul>
+<p>The first incubating release of Apache Beam.</p>
</div>