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 2020/05/29 18:03:11 UTC
[beam] branch asf-site updated: Publishing website 2020/05/29
18:02:59 at commit 1bcb551
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 a3c6d1d Publishing website 2020/05/29 18:02:59 at commit 1bcb551
a3c6d1d is described below
commit a3c6d1d585d60d125eedc24c4c0ee744217d4a48
Author: jenkins <bu...@apache.org>
AuthorDate: Fri May 29 18:02:59 2020 +0000
Publishing website 2020/05/29 18:02:59 at commit 1bcb551
---
website/generated-content/contribute/index.xml | 39 +++++-----------------
.../contribute/release-guide/index.html | 11 +++---
website/generated-content/sitemap.xml | 2 +-
3 files changed, 14 insertions(+), 38 deletions(-)
diff --git a/website/generated-content/contribute/index.xml b/website/generated-content/contribute/index.xml
index e1e2ef6..96cfa6d 100644
--- a/website/generated-content/contribute/index.xml
+++ b/website/generated-content/contribute/index.xml
@@ -921,13 +921,6 @@ ls -al /opt/apache/beam/third_party_licenses/ | wc -l
please run <a href="https://github.com/apache/beam/blob/master/release/src/main/scripts/sign_hash_python_wheels.sh">./sign_hash_python_wheels.sh</a>, which copies the wheels along with signatures and hashes to <a href="https://dist.apache.org/repos/dist/dev/beam/">dist.apache.org</a>.</li>
</ul>
</li>
-<li>Update Beam website (<a href="https://github.com/apache/beam/pull/11727">example</a>)
-<ol>
-<li>Update release version in <code>website/www/site/config.toml</code>.</li>
-<li>Add new release in <code>website/www/site/content/en/get-started/downloads.md</code>.</li>
-<li>Update <code>website/www/site/static/.htaccess</code> to redirect to the new version.</li>
-</ol>
-</li>
</ol>
<hr>
<h2 id="6-prepare-documents">6. Prepare documents</h2>
@@ -967,31 +960,18 @@ the PR is merged, the new contents will get picked up automatically and served
to the Beam website, usually within an hour.</p>
<p><strong>PR 1: apache/beam-site</strong></p>
<p>This pull request is against the <code>apache/beam-site</code> repo, on the <code>release-docs</code>
-branch.</p>
-<ul>
-<li>Add the new Javadoc to <a href="https://beam.apache.org/releases/javadoc/">SDK API Reference page</a> page, as follows:
+branch (<a href="https://github.com/apache/beam-site/pull/603">example</a>).
+It is created by <code>build_release_candidate.sh</code> (see above).</p>
+<p><strong>PR 2: apache/beam</strong></p>
+<p>This pull request is against the <code>apache/beam</code> repo, on the <code>master</code> branch (<a href="https://github.com/apache/beam/pull/11727">example</a>).</p>
<ul>
-<li>Unpack the Maven artifact <code>org.apache.beam:beam-sdks-java-javadoc</code> into some temporary location. Call this <code>${JAVADOC_TMP}</code>.</li>
-<li>Copy the generated Javadoc into the website repository: <code>cp -r ${JAVADOC_TMP} javadoc/${RELEASE}</code>.</li>
-</ul>
-</li>
-<li>Add the new Pydoc to <a href="https://beam.apache.org/releases/pydoc/">SDK API Reference page</a> page, as follows:
+<li>Update release version in <code>website/www/site/config.toml</code>.</li>
+<li>Add new release in <code>website/www/site/content/en/get-started/downloads.md</code>.
<ul>
-<li>Copy the generated Pydoc into the website repository: <code>cp -r ${PYDOC_ROOT} pydoc/${RELEASE}</code>.</li>
-<li>Remove <code>.doctrees</code> directory.</li>
+<li>Download links will not work until the release is finalized.</li>
</ul>
</li>
-<li>Stage files using: <code>git add --all javadoc/ pydoc/</code>.</li>
-</ul>
-<p><strong>PR 2: apache/beam</strong></p>
-<p>This pull request is against the <code>apache/beam</code> repo, on the <code>master</code> branch.</p>
-<ul>
-<li>Update the <code>release_latest</code> version flag in <code>/website/_config.yml</code>, and list
-the new release in <code>/website/src/get-started/downloads.md</code>, linking to the
-source code download and the Release Notes in JIRA.</li>
-<li>Update the <code>RedirectMatch</code> rule in
-<a href="https://github.com/apache/beam/blob/master/website/src/.htaccess">/website/src/.htaccess</a>
-to point to the new release. See file history for examples.</li>
+<li>Update <code>website/www/site/static/.htaccess</code> to redirect to the new version.</li>
</ul>
<h3 id="blog-post">Blog post</h3>
<p>Write a blog post similar to <a href="https://github.com/apache/beam/blob/master/website/www/site/content/en/blog/beam-2.20.0.md">beam-2.20.0.md</a>.</p>
@@ -1389,9 +1369,8 @@ All wheels should be published, in addition to the zip of the release source.
</ul>
<h3 id="deploy-source-release-to-distapacheorg">Deploy source release to dist.apache.org</h3>
<p>Copy the source release from the <code>dev</code> repository to the <code>release</code> repository at <code>dist.apache.org</code> using Subversion.</p>
-<p>Move last release artifacts from <code>dist.apache.org</code> to <code>archive.apache.org</code> using Subversion. Then update download address for last release version, <a href="https://github.com/apache/beam-site/pull/478">example PR</a>.</p>
+<p>Move last release artifacts from <code>dist.apache.org</code> to <code>archive.apache.org</code> using Subversion. Make sure to change these links on the website (<a href="https://github.com/apache/beam/pull/11727">example</a>).</p>
<p><strong>NOTE</strong>: Only PMC members have permissions to do it, ping <a href="mailto:dev@beam.apache.org">dev@</a> for assitance;</p>
-<p>Make sure the download address for last release version is upldaed, <a href="https://github.com/apache/beam-site/pull/478">example PR</a>.</p>
<h3 id="deploy-sdk-docker-images-to-dockerhub">Deploy SDK docker images to DockerHub</h3>
<ul>
<li>Script: <a href="https://github.com/apache/beam/blob/master/release/src/main/scripts/publish_docker_images.sh">publish_docker_images.sh</a></li>
diff --git a/website/generated-content/contribute/release-guide/index.html b/website/generated-content/contribute/release-guide/index.html
index ddf2f1a..a10c45b 100644
--- a/website/generated-content/contribute/release-guide/index.html
+++ b/website/generated-content/contribute/release-guide/index.html
@@ -132,7 +132,7 @@ ls -al /opt/apache/beam/third_party_licenses/ | wc -l
</code></pre><ul><li>For Java SDK images, there should be around 1400 dependencies.</li></ul><pre><code>docker run -it --entrypoint=/bin/bash apache/beam_java_sdk:${RELEASE}_rc{RC_NUM}
ls -al /opt/apache/beam/third_party_licenses/ | wc -l
</code></pre></li></ol></li><li>Publish staging artifacts<ol><li>Log in to the <a href=https://repository.apache.org/#stagingRepositories>Apache Nexus</a> website.</li><li>Navigate to Build Promotion -> Staging Repositories (in the left sidebar).</li><li>Select repository <code>orgapachebeam-NNNN</code>.</li><li>Click the Close button.</li><li>When prompted for a description, enter “Apache Beam, version X, release candidate Y”.</li><li>Review all staged artifacts on <a href=https://repos [...]
-please run <a href=https://github.com/apache/beam/blob/master/release/src/main/scripts/sign_hash_python_wheels.sh>./sign_hash_python_wheels.sh</a>, which copies the wheels along with signatures and hashes to <a href=https://dist.apache.org/repos/dist/dev/beam/>dist.apache.org</a>.</li></ul></li><li>Update Beam website (<a href=https://github.com/apache/beam/pull/11727>example</a>)<ol><li>Update release version in <code>website/www/site/config.toml</code>.</li><li>Add new release in <code [...]
+please run <a href=https://github.com/apache/beam/blob/master/release/src/main/scripts/sign_hash_python_wheels.sh>./sign_hash_python_wheels.sh</a>, which copies the wheels along with signatures and hashes to <a href=https://dist.apache.org/repos/dist/dev/beam/>dist.apache.org</a>.</li></ul></li></ol><hr><h2 id=6-prepare-documents>6. Prepare documents</h2><h3 id=update-and-verify-javadoc>Update and Verify Javadoc</h3><p>The build with <code>-PisRelease</code> creates the combined Javadoc [...]
in and exclude, plus a list of offline URLs that populate links from Beam’s
Javadoc to the Javadoc for other modules that Beam depends on.</p><ul><li><p>Confirm that new modules added since the last release have been added to the
inclusion list as appropriate.</p></li><li><p>Confirm that the excluded package list is up to date.</p></li><li><p>Verify the version numbers for offline links match the versions used by Beam. If
@@ -146,11 +146,8 @@ manuals.</p><p>Merge the pull requests only after finalizing the release. To avo
redirects for the ‘current’ version, merge these PRs in the order listed. Once
the PR is merged, the new contents will get picked up automatically and served
to the Beam website, usually within an hour.</p><p><strong>PR 1: apache/beam-site</strong></p><p>This pull request is against the <code>apache/beam-site</code> repo, on the <code>release-docs</code>
-branch.</p><ul><li>Add the new Javadoc to <a href=https://beam.apache.org/releases/javadoc/>SDK API Reference page</a> page, as follows:<ul><li>Unpack the Maven artifact <code>org.apache.beam:beam-sdks-java-javadoc</code> into some temporary location. Call this <code>${JAVADOC_TMP}</code>.</li><li>Copy the generated Javadoc into the website repository: <code>cp -r ${JAVADOC_TMP} javadoc/${RELEASE}</code>.</li></ul></li><li>Add the new Pydoc to <a href=https://beam.apache.org/releases/pyd [...]
-the new release in <code>/website/src/get-started/downloads.md</code>, linking to the
-source code download and the Release Notes in JIRA.</li><li>Update the <code>RedirectMatch</code> rule in
-<a href=https://github.com/apache/beam/blob/master/website/src/.htaccess>/website/src/.htaccess</a>
-to point to the new release. See file history for examples.</li></ul><h3 id=blog-post>Blog post</h3><p>Write a blog post similar to <a href=https://github.com/apache/beam/blob/master/website/www/site/content/en/blog/beam-2.20.0.md>beam-2.20.0.md</a>.</p><ul><li>Update <code>CHANGES.md</code> by adding a new section for the next release.</li><li>Copy the changes for the current release from <code>CHANGES.md</code> to the blog post and edit as necessary.</li></ul><p><strong>Tip</strong>: U [...]
+branch (<a href=https://github.com/apache/beam-site/pull/603>example</a>).
+It is created by <code>build_release_candidate.sh</code> (see above).</p><p><strong>PR 2: apache/beam</strong></p><p>This pull request is against the <code>apache/beam</code> repo, on the <code>master</code> branch (<a href=https://github.com/apache/beam/pull/11727>example</a>).</p><ul><li>Update release version in <code>website/www/site/config.toml</code>.</li><li>Add new release in <code>website/www/site/content/en/get-started/downloads.md</code>.<ul><li>Download links will not work un [...]
Make sure to clean it up, as there may be duplicate or incorrect user names.</p><p><strong>NOTE</strong>: Make sure to include any breaking changes, even to <code>@Experimental</code> features,
all major features and bug fixes, and all known issues.</p><p>Template:</p><pre><code>We are happy to present the new {$RELEASE_VERSION} release of Beam. This release includes both improvements and new functionality.
See the [download page](/get-started/downloads/{$DOWNLOAD_ANCHOR}) for this release.
@@ -358,7 +355,7 @@ mvn compile exec:java -Dexec.mainClass=org.apache.beam.examples.complete.game.in
please follow <a href=https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/>the guide</a> to configure command line access.</p><h3 id=deploy-python-artifacts-to-pypi>Deploy Python artifacts to PyPI</h3><ul><li>Script: <a href=https://github.com/apache/beam/blob/master/release/src/main/scripts/deploy_pypi.sh>deploy_pypi.sh</a></li><li>Usage</li></ul><pre><code>./beam/release/src/main/scripts/deploy_pypi.sh
</code></pre><ul><li>Verify that the files at <a href=https://pypi.org/project/apache-beam/#files>https://pypi.org/project/apache-beam/#files</a> are correct.
All wheels should be published, in addition to the zip of the release source.
-(Signatures and hashes do <em>not</em> need to be uploaded.)</li></ul><h3 id=deploy-source-release-to-distapacheorg>Deploy source release to dist.apache.org</h3><p>Copy the source release from the <code>dev</code> repository to the <code>release</code> repository at <code>dist.apache.org</code> using Subversion.</p><p>Move last release artifacts from <code>dist.apache.org</code> to <code>archive.apache.org</code> using Subversion. Then update download address for last release version, <a [...]
+(Signatures and hashes do <em>not</em> need to be uploaded.)</li></ul><h3 id=deploy-source-release-to-distapacheorg>Deploy source release to dist.apache.org</h3><p>Copy the source release from the <code>dev</code> repository to the <code>release</code> repository at <code>dist.apache.org</code> using Subversion.</p><p>Move last release artifacts from <code>dist.apache.org</code> to <code>archive.apache.org</code> using Subversion. Make sure to change these links on the website (<a href=h [...]
</code></pre><p>Verify that:</p><ul><li>Images are published at <a href="https://hub.docker.com/search?q=apache%2Fbeam&type=image">DockerHub</a> with tags {RELEASE} and <em>latest</em>.</li><li>Images with <em>latest</em> tag are pointing to current release by confirming<ol><li>Digest of the image with <em>latest</em> tag is the same as the one with {RELEASE} tag.</li></ol></li></ul><h3 id=git-tag>Git tag</h3><p>Create and push a new signed tag for the released version by copying the tag [...]
git tag -s "$VERSION_TAG" "$RC_TAG"
git push github "$VERSION_TAG"
diff --git a/website/generated-content/sitemap.xml b/website/generated-content/sitemap.xml
index 080cb6b..bbbbe63 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>/categories/blog/</loc><lastmod>2020-05-28T15:14:36-07:00</lastmod></url><url><loc>/blog/</loc><lastmod>2020-05-28T15:14:36-07:00</lastmod></url><url><loc>/categories/</loc><lastmod>2020-05-28T15:14:36-07:00</lastmod></url><url><loc>/categories/python/</loc><lastmod>2020-05-28T15:14:36-07:00</lastmod></url><url><loc>/blog/ [...]
\ 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>/categories/blog/</loc><lastmod>2020-05-28T15:14:36-07:00</lastmod></url><url><loc>/blog/</loc><lastmod>2020-05-28T15:14:36-07:00</lastmod></url><url><loc>/categories/</loc><lastmod>2020-05-28T15:14:36-07:00</lastmod></url><url><loc>/categories/python/</loc><lastmod>2020-05-28T15:14:36-07:00</lastmod></url><url><loc>/blog/ [...]
\ No newline at end of file