You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by gi...@apache.org on 2021/03/18 06:04:25 UTC
[beam] branch asf-site updated: Publishing website 2021/03/18
06:03:47 at commit 9791ef9
This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 3ae914e Publishing website 2021/03/18 06:03:47 at commit 9791ef9
3ae914e is described below
commit 3ae914eff2d4faca2a08cb6f2a076ac0c10d47dd
Author: jenkins <bu...@apache.org>
AuthorDate: Thu Mar 18 06:03:47 2021 +0000
Publishing website 2021/03/18 06:03:47 at commit 9791ef9
---
website/generated-content/contribute/index.xml | 33 ++++++++++++++++++++-
.../contribute/release-guide/index.html | 19 +++++++++---
website/generated-content/images/tag-rc-commit.png | Bin 0 -> 24964 bytes
website/generated-content/sitemap.xml | 2 +-
4 files changed, 48 insertions(+), 6 deletions(-)
diff --git a/website/generated-content/contribute/index.xml b/website/generated-content/contribute/index.xml
index f48b7cf..c91e2e5 100644
--- a/website/generated-content/contribute/index.xml
+++ b/website/generated-content/contribute/index.xml
@@ -334,6 +334,7 @@ limitations under the License.
<li><a href="#7-build-a-release-candidate">7. Build a release candidate</a>
<ul>
<li><a href="#checklist-before-proceeding">Checklist before proceeding</a></li>
+<li><a href="#tag-a-chosen-commit-for-the-rc">Tag a chosen commit for the RC</a></li>
<li><a href="#run-build_release_candidatesh-to-create-a-release-candidate">Run build_release_candidate.sh to create a release candidate</a>
<ul>
<li><a href="#tasks-you-need-to-do-manually">Tasks you need to do manually</a></li>
@@ -861,6 +862,36 @@ Consider adding known issues there for minor issues instead of accepting cherry
Each cycle produces one release candidate.
The Release Manager repeats this cycle until the community approves one release candidate, which is then finalized.</p>
<p>For this step, we recommend you using automation script to create a RC, but you still can perform all steps manually if you want.</p>
+<h3 id="tag-a-chosen-commit-for-the-rc">Tag a chosen commit for the RC</h3>
+<p>Release candidates are built from single commits off the release branch.
+Before building, the version must be set to a non-SNAPSHOT, non-dev version.
+The final state of the repository should match this diagram:</p>
+<p><img src="/images/tag-rc-commit.png" alt="Set version to non-SNAPSHOT, non-dev, on tagged RC commit" width="100%" /></p>
+<ul>
+<li>The release branch is unchanged.</li>
+<li>There is a commit not on the release branch with the version adjusted.</li>
+<li>The RC tag points to that commit.</li>
+</ul>
+<ul>
+<li>
+<p><strong>Script:</strong> <a href="https://github.com/apache/beam/blob/master/release/src/main/scripts/choose_rc_commit.sh">choose_rc_commit.sh</a></p>
+</li>
+<li>
+<p><strong>Usage</strong></p>
+<pre><code>./beam/release/src/main/scripts/choose_rc_commit.sh \
+--release &quot;${RELEASE_VERSION}&quot; \
+--rc &quot;${RC_NUM}&quot; \
+--commit &quot;${COMMIT_REF}&quot; \
+--clone \
+--push-tag
+</code></pre>
+</li>
+</ul>
+<p>You can do a dry run by omitting the <code>--push-tag</code> flag. Then it will only clone the repo,
+adjust the version, and add the tag locally. If it looks good, run it again with <code>--push-tag</code>.
+If you already have a clone that includes the <code>${COMMIT_REF}</code> then you can omit <code>--clone</code>. This
+is perfectly safe since the script does not depend on the current working tree.</p>
+<p>See the source of the script for more details, or to run commands manually in case of a problem.</p>
<h3 id="run-build_release_candidatesh-to-create-a-release-candidate">Run build_release_candidate.sh to create a release candidate</h3>
<ul>
<li>
@@ -874,7 +905,7 @@ The Release Manager repeats this cycle until the community approves one release
<li>
<p><strong>The script will:</strong></p>
<ol>
-<li>Run gradle release to create rc tag and push source release into github repo.</li>
+<li>Clone the repo at the selected RC tag.</li>
<li>Run gradle publish to push java artifacts into Maven staging repo.</li>
<li>Stage source release into dist.apache.org dev <a href="https://dist.apache.org/repos/dist/dev/beam/">repo</a>.</li>
<li>Stage, sign and hash python source distribution and wheels into dist.apache.org dev repo python dir</li>
diff --git a/website/generated-content/contribute/release-guide/index.html b/website/generated-content/contribute/release-guide/index.html
index 36f9eb0..10412ce 100644
--- a/website/generated-content/contribute/release-guide/index.html
+++ b/website/generated-content/contribute/release-guide/index.html
@@ -18,7 +18,7 @@
function addPlaceholder(){$('input:text').attr('placeholder',"What are you looking for?");}
function endSearch(){var search=document.querySelector(".searchBar");search.classList.add("disappear");var icons=document.querySelector("#iconsBar");icons.classList.remove("disappear");}
function blockScroll(){$("body").toggleClass("fixedPosition");}
-function openMenu(){addPlaceholder();blockScroll();}</script><div class="clearfix container-main-content"><div class="section-nav closed" data-offset-top=90 data-offset-bottom=500><span class="section-nav-back glyphicon glyphicon-menu-left"></span><nav><ul class=section-nav-list data-section-nav><li><span class=section-nav-list-main-title>Contribute</span></li><li><a href=/contribute/>Get started contributing</a></li><li><a href=/contribute/get-help/>Get Help</a></li><li><a href=/contrib [...]
+function openMenu(){addPlaceholder();blockScroll();}</script><div class="clearfix container-main-content"><div class="section-nav closed" data-offset-top=90 data-offset-bottom=500><span class="section-nav-back glyphicon glyphicon-menu-left"></span><nav><ul class=section-nav-list data-section-nav><li><span class=section-nav-list-main-title>Contribute</span></li><li><a href=/contribute/>Get started contributing</a></li><li><a href=/contribute/get-help/>Get Help</a></li><li><a href=/contrib [...]
A release is one or more packages of the project artifact(s) that are approved for general public distribution and use.
They may come with various degrees of caveat regarding their perceived quality and potential for change, such as “alpha”, “beta”, “incubating”, “stable”, etc.</p><p>The Beam community treats releases with great importance.
They are a public face of the project and most users interact with the project only through the releases. Releases are signed off by the entire Beam community in a public vote.</p><p>Each release is executed by a <em>Release Manager</em>, who is selected among the Beam committers.
@@ -135,8 +135,19 @@ However, beyond that each cherry pick will increase the time required for the re
Neither late releases nor not fully tested code will provide positive user value.</p><p><strong>Tip</strong>: Another tool in your toolbox is the known issues section of the release blog.
Consider adding known issues there for minor issues instead of accepting cherry picks to the release branch.</p><hr><h2 id=7-build-a-release-candidate>7. Build a release candidate</h2><h3 id=checklist-before-proceeding>Checklist before proceeding</h3><ul><li>Release Manager’s GPG key is published to <code>dist.apache.org</code>;</li><li>Release Manager’s GPG key is configured in <code>git</code> configuration;</li><li>Release Manager has <code>org.apache.beam</code> listed under <code>St [...]
Each cycle produces one release candidate.
-The Release Manager repeats this cycle until the community approves one release candidate, which is then finalized.</p><p>For this step, we recommend you using automation script to create a RC, but you still can perform all steps manually if you want.</p><h3 id=run-build_release_candidatesh-to-create-a-release-candidate>Run build_release_candidate.sh to create a release candidate</h3><ul><li><p><strong>Script:</strong> <a href=https://github.com/apache/beam/blob/master/release/src/main/s [...]
-</code></pre></li><li><p><strong>The script will:</strong></p><ol><li>Run gradle release to create rc tag and push source release into github repo.</li><li>Run gradle publish to push java artifacts into Maven staging repo.</li><li>Stage source release into dist.apache.org dev <a href=https://dist.apache.org/repos/dist/dev/beam/>repo</a>.</li><li>Stage, sign and hash python source distribution and wheels into dist.apache.org dev repo python dir</li><li>Stage SDK docker images to <a href=" [...]
+The Release Manager repeats this cycle until the community approves one release candidate, which is then finalized.</p><p>For this step, we recommend you using automation script to create a RC, but you still can perform all steps manually if you want.</p><h3 id=tag-a-chosen-commit-for-the-rc>Tag a chosen commit for the RC</h3><p>Release candidates are built from single commits off the release branch.
+Before building, the version must be set to a non-SNAPSHOT, non-dev version.
+The final state of the repository should match this diagram:</p><p><img src=/images/tag-rc-commit.png alt="Set version to non-SNAPSHOT, non-dev, on tagged RC commit" width=100%></p><ul><li>The release branch is unchanged.</li><li>There is a commit not on the release branch with the version adjusted.</li><li>The RC tag points to that commit.</li></ul><ul><li><p><strong>Script:</strong> <a href=https://github.com/apache/beam/blob/master/release/src/main/scripts/choose_rc_commit.sh>choose_r [...]
+ --release "${RELEASE_VERSION}" \
+ --rc "${RC_NUM}" \
+ --commit "${COMMIT_REF}" \
+ --clone \
+ --push-tag
+</code></pre></li></ul><p>You can do a dry run by omitting the <code>--push-tag</code> flag. Then it will only clone the repo,
+adjust the version, and add the tag locally. If it looks good, run it again with <code>--push-tag</code>.
+If you already have a clone that includes the <code>${COMMIT_REF}</code> then you can omit <code>--clone</code>. This
+is perfectly safe since the script does not depend on the current working tree.</p><p>See the source of the script for more details, or to run commands manually in case of a problem.</p><h3 id=run-build_release_candidatesh-to-create-a-release-candidate>Run build_release_candidate.sh to create a release candidate</h3><ul><li><p><strong>Script:</strong> <a href=https://github.com/apache/beam/blob/master/release/src/main/scripts/build_release_candidate.sh>build_release_candidate.sh</a></p>< [...]
+</code></pre></li><li><p><strong>The script will:</strong></p><ol><li>Clone the repo at the selected RC tag.</li><li>Run gradle publish to push java artifacts into Maven staging repo.</li><li>Stage source release into dist.apache.org dev <a href=https://dist.apache.org/repos/dist/dev/beam/>repo</a>.</li><li>Stage, sign and hash python source distribution and wheels into dist.apache.org dev repo python dir</li><li>Stage SDK docker images to <a href="https://hub.docker.com/search?q=apache% [...]
Please note that dependencies for the SDKs with different Python versions vary.
Need to verify all Python images by replacing <code>${ver}</code> with each supported Python version <code>X.Y</code>.</li></ul><pre><code>docker run -it --entrypoint=/bin/bash apache/beam_python${ver}_sdk:${RELEASE}_rc{RC_NUM}
ls -al /opt/apache/beam/third_party_licenses/ | wc -l
@@ -395,7 +406,7 @@ If you end up getting permissions errors ask on the mailing list for assistance.
Ask other contributors to do the same.</p><p>Also, update <a href=https://en.wikipedia.org/wiki/Apache_Beam>the Wikipedia article on Apache Beam</a>.</p><h3 id=checklist-to-declare-the-process-completed>Checklist to declare the process completed</h3><ol><li>Release announced on the user@ mailing list.</li><li>Blog post published, if applicable.</li><li>Release recorded in reporter.apache.org.</li><li>Release announced on social media.</li><li>Completion declared on the dev@ mailing list. [...]
Once you’ve finished the release, please take a step back and look what areas of this process and be improved. Perhaps some part of the process can be simplified.
Perhaps parts of this guide can be clarified.</p><p>If we have specific ideas, please start a discussion on the dev@ mailing list and/or propose a pull request to update this guide.
-Thanks!</p><div class=feedback><p class=update>Last updated on 2021/03/15</p><h3>Have you found everything you were looking for?</h3><p class=description>Was it all useful and clear? Is there anything that you would like to change? Let us know!</p><button class=load-button><a href="mailto:dev@beam.apache.org?subject=Beam Website Feedback">SEND FEEDBACK</a></button></div></div></div><footer class=footer><div class=footer__contained><div class=footer__cols><div class="footer__cols__col foo [...]
+Thanks!</p><div class=feedback><p class=update>Last updated on 2021/03/16</p><h3>Have you found everything you were looking for?</h3><p class=description>Was it all useful and clear? Is there anything that you would like to change? Let us know!</p><button class=load-button><a href="mailto:dev@beam.apache.org?subject=Beam Website Feedback">SEND FEEDBACK</a></button></div></div></div><footer class=footer><div class=footer__contained><div class=footer__cols><div class="footer__cols__col foo [...]
<a href=http://www.apache.org>The Apache Software Foundation</a>
| <a href=/privacy_policy>Privacy Policy</a>
| <a href=/feed.xml>RSS Feed</a><br><br>Apache Beam, Apache, Beam, the Beam logo, and the Apache feather logo are either registered trademarks or trademarks of The Apache Software Foundation. All other products or name brands are trademarks of their respective holders, including The Apache Software Foundation.</div></div></div></div></footer></body></html>
\ No newline at end of file
diff --git a/website/generated-content/images/tag-rc-commit.png b/website/generated-content/images/tag-rc-commit.png
new file mode 100644
index 0000000..aa96d7b
Binary files /dev/null and b/website/generated-content/images/tag-rc-commit.png differ
diff --git a/website/generated-content/sitemap.xml b/website/generated-content/sitemap.xml
index 4bda51a..985bbc5 100644
--- a/website/generated-content/sitemap.xml
+++ b/website/generated-content/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/blog/beam-2.28.0/</loc><lastmod>2021-02-22T11:40:20-08:00</lastmod></url><url><loc>/categories/blog/</loc><lastmod>2021-02-22T11:40:20-08:00</lastmod></url><url><loc>/blog/</loc><lastmod>2021-02-22T11:40:20-08:00</lastmod></url><url><loc>/categories/</loc><lastmod>2021-03-16T13:53:01+05:00</lastmod></url><url><loc>/blog/k [...]
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/blog/beam-2.28.0/</loc><lastmod>2021-02-22T11:40:20-08:00</lastmod></url><url><loc>/categories/blog/</loc><lastmod>2021-02-22T11:40:20-08:00</lastmod></url><url><loc>/blog/</loc><lastmod>2021-02-22T11:40:20-08:00</lastmod></url><url><loc>/categories/</loc><lastmod>2021-03-16T13:53:01+05:00</lastmod></url><url><loc>/blog/k [...]
\ No newline at end of file