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 1dc20933db5 Publishing website 2023/08/25 22:16:04 at commit 0ab1e58 1dc20933db5 is described below commit 1dc20933db5742d318aef3caa4b2ef571aba4031 Author: jenkins <bui...@apache.org> AuthorDate: Fri Aug 25 22:16:04 2023 +0000 Publishing website 2023/08/25 22:16:04 at commit 0ab1e58 --- website/generated-content/contribute/index.xml | 14 ++++++++++++-- .../generated-content/contribute/release-guide/index.html | 9 +++++---- website/generated-content/documentation/index.html | 2 +- website/generated-content/sitemap.xml | 2 +- 4 files changed, 19 insertions(+), 8 deletions(-) diff --git a/website/generated-content/contribute/index.xml b/website/generated-content/contribute/index.xml index d7af2d3376f..5899bb38bcc 100644 --- a/website/generated-content/contribute/index.xml +++ b/website/generated-content/contribute/index.xml @@ -345,7 +345,11 @@ limitations under the License. </li> <li><a href="#8-build-a-release-candidate">8. Build a release candidate</a> <ul> +<li> +<ul> <li><a href="#checklist-before-proceeding">Checklist before proceeding</a></li> +</ul> +</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_candidate-github-action-to-create-a-release-candidate">Run build_release_candidate GitHub Action to create a release candidate</a> <ul> @@ -812,7 +816,7 @@ Neither late releases nor not fully tested code will provide positive user value Consider adding known issues there for minor issues instead of accepting cherry picks to the release branch.</p> <hr> <h2 id="8-build-a-release-candidate">8. Build a release candidate</h2> -<h3 id="checklist-before-proceeding">Checklist before proceeding</h3> +<h4 id="checklist-before-proceeding">Checklist before proceeding</h4> <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> @@ -876,6 +880,11 @@ You don&rsquo;t need to wait for the action to complete to start running the <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 SDK docker images to <a href="https://hub.docker.com/search?q=apache%2Fbeam&amp;type=image">docker hub Apache organization</a>.</li> +<li>Build javadoc, pydoc, typedocs for a PR to update beam-site. +<ul> +<li><strong>NOTE</strong>: Do not merge this PR until after an RC has been approved (see &ldquo;Finalize the Release&rdquo;).</li> +</ul> +</li> </ol> </li> </ul> @@ -921,7 +930,8 @@ help with this step. Please email <code>dev@</code> and ask a member of th <ul> <li>Copy python doc into beam-site</li> <li>Copy java doc into beam-site</li> -<li><strong>NOTE</strong>: Do not merge this PR until after an RC has been approved (see &ldquo;Finalize the Release&rdquo;).</li> +<li><strong>NOTE</strong>: Do not merge this PR until after an RC has been approved (see &ldquo;Finalize the Release&rdquo;). +Skip this step if you already did it with the build_release_candidate GitHub Actions workflow.</li> </ul> </li> </ol> diff --git a/website/generated-content/contribute/release-guide/index.html b/website/generated-content/contribute/release-guide/index.html index a4088078ee9..20cc837c0ac 100644 --- a/website/generated-content/contribute/release-guide/index.html +++ b/website/generated-content/contribute/release-guide/index.html @@ -36,7 +36,7 @@ <img class=banner-img-mobile src=/images/banners/tour-of-beam/tour-of-beam-mobile.png alt="Start Tour of Beam"></a></div><div class=swiper-slide><a href=https://beam.apache.org/documentation/ml/overview/><img class=banner-img-desktop src=/images/banners/machine-learning/machine-learning-desktop.jpg alt="Machine Learning"> <img class=banner-img-mobile src=/images/banners/machine-learning/machine-learning-mobile.jpg alt="Machine Learning"></a></div></div><div class=swiper-pagination></div></div><script src=/js/swiper-bundle.min.min.e0e8f81b0b15728d35ff73c07f42ddbb17a108d6f23df4953cb3e60df7ade675.js></script> <script src=/js/sliders/top-banners.min.91104c476b3d8123ebee5ed9a8168556ec546abb698549551b38a0cee187ee1c.js></script> -<script>function showSearch(){addPlaceholder();var e,t=document.querySelector(".searchBar");t.classList.remove("disappear"),e=document.querySelector("#iconsBar"),e.classList.add("disappear")}function addPlaceholder(){$("input:text").attr("placeholder","What are you looking for?")}function endSearch(){var e,t=document.querySelector(".searchBar");t.classList.add("disappear"),e=document.querySelector("#iconsBar"),e.classList.remove("disappear")}function blockScroll(){$("body").toggleClass(" [...] +<script>function showSearch(){addPlaceholder();var e,t=document.querySelector(".searchBar");t.classList.remove("disappear"),e=document.querySelector("#iconsBar"),e.classList.add("disappear")}function addPlaceholder(){$("input:text").attr("placeholder","What are you looking for?")}function endSearch(){var e,t=document.querySelector(".searchBar");t.classList.add("disappear"),e=document.querySelector("#iconsBar"),e.classList.remove("disappear")}function blockScroll(){$("body").toggleClass(" [...] 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. @@ -141,7 +141,7 @@ Make sure they have blocker Issues attached and are OK to get into the release b You are encouraged to ask the following questions to be answered on each cherry-pick PR and you can choose to reject cherry-pick requests if these questions are not satisfactorily answered:</p><ul><li>Is this a regression from a previous release? (If no, fix could go to a newer version.)</li><li>Is this a new feature or related to a new feature? (If yes, fix could go to a new version.)</li><li>Would this impact production workloads for users? (E.g. if this is a direct runner only fix it [...] However, beyond that each cherry pick will increase the time required for the release and add more last minute code to the release branch. 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=8-build-a-release-candidate>8. 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>Set <code>SIGNING_KEY</code> to the public key of the Manager’s [...] +Consider adding known issues there for minor issues instead of accepting cherry picks to the release branch.</p><hr><h2 id=8-build-a-release-candidate>8. Build a release candidate</h2><h4 id=checklist-before-proceeding>Checklist before proceeding</h4><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>Set <code>SIGNING_KEY</code> to the public key of the Manager’s [...] 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. @@ -155,7 +155,7 @@ The final state of the repository should match this diagram:</p><img src=/images 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_candidate-github-action-to-create-a-release-candidate>Run build_release_candidate GitHub Action to create a release candidate</h3><p>Note: This step is partially automated (in progress), so part of the rc creation is done by GitHub Actions and the rest is done by a script. -You don’t need to wait for the action to complete to start running the script.</p><ul><li><p><strong>Action</strong> <a href=https://github.com/apache/beam/actions/workflows/build_release_candidate.yml>build_release_candidate</a> (click <code>run workflow</code>)</p></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 SDK docker images to <a href="http [...] +You don’t need to wait for the action to complete to start running the script.</p><ul><li><p><strong>Action</strong> <a href=https://github.com/apache/beam/actions/workflows/build_release_candidate.yml>build_release_candidate</a> (click <code>run workflow</code>)</p></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 SDK docker images to <a href="http [...] They should contain all relevant parts for each module, including <code>pom.xml</code>, jar, test jar, javadoc, etc. Artifact names should follow <a href=https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.beam%22>the existing format</a> in which artifact name mirrors directory structure, e.g., <code>beam-sdks-java-io-kafka</code>. Carefully review any new artifacts. @@ -164,7 +164,8 @@ Some additional validation should be done during the rc validation step.</li></o Skip this step if you already did it with the build_release_candidate GitHub Actions workflow.</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%2Fbeam&type=image">docker hub Apache organization</a>. Skip this step if you already did it with the build_release_candidate GitHub Actions workflow. Note: if you are not a member of the <a href=https://hub.docker.com/orgs/apache/teams/beam><code>beam</code> DockerHub team</a> you will need -help with this step. Please email <code>dev@</code> and ask a member of the <code>beam</code> DockerHub team for help.</li><li>Create a PR to update beam-site, changes includes:<ul><li>Copy python doc into beam-site</li><li>Copy java doc into beam-site</li><li><strong>NOTE</strong>: Do not merge this PR until after an RC has been approved (see “Finalize the Release”).</li></ul></li></ol></li></ul><h4 id=tasks-you-need-to-do-manually-1>Tasks you need to do manually</h4><ol><li [...] +help with this step. Please email <code>dev@</code> and ask a member of the <code>beam</code> DockerHub team for help.</li><li>Create a PR to update beam-site, changes includes:<ul><li>Copy python doc into beam-site</li><li>Copy java doc into beam-site</li><li><strong>NOTE</strong>: Do not merge this PR until after an RC has been approved (see “Finalize the Release”). +Skip this step if you already did it with the build_release_candidate GitHub Actions workflow.</li></ul></li></ol></li></ul><h4 id=tasks-you-need-to-do-manually-1>Tasks you need to do manually</h4><ol><li>Verify the script worked.<ol><li>Verify that the source and Python binaries are present in <a href=https://dist.apache.org/repos/dist/dev/beam>dist.apache.org</a>.</li><li>Verify Docker images are published. How to find images:<ol><li>Visit <a href="https://hub.docker.com/search?q=apach [...] 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 tabindex=0><code>docker run --rm -it --entrypoint=/bin/bash apache/beam_python${ver}_sdk:${RELEASE_VERSION}rc${RC_NUM} ls -al /opt/apache/beam/third_party_licenses/ | wc -l diff --git a/website/generated-content/documentation/index.html b/website/generated-content/documentation/index.html index 2401a0420ab..2efe78d4a06 100644 --- a/website/generated-content/documentation/index.html +++ b/website/generated-content/documentation/index.html @@ -48,7 +48,7 @@ Beam programming model.</li></ul><h2 id=pipeline-fundamentals>Pipeline Fundament planning your pipeline’s structure, choosing transforms to apply to your data, and determining your input and output methods.</li><li><a href=/documentation/pipelines/create-your-pipeline/>Create Your Pipeline</a> using the classes in the Beam SDKs.</li><li><a href=/documentation/pipelines/test-your-pipeline/>Test Your Pipeline</a> to minimize -debugging a pipeline’s remote execution.</li></ul><h2 id=sdks>SDKs</h2><p>Find status and reference information on all of the available Beam SDKs.</p><div class=sdks><div class=item-description><a href=/documentation/sdks/java/ class=font-weight-bold>Java SDK</a><p></p></div><div class=item-description><a href=/documentation/sdks/python/ class=font-weight-bold>Python SDK</a><p></p></div><div class=item-description><a href=/documentation/sdks/go/ class=font-weight-bold>Go SDK</a><p></p></ [...] +debugging a pipeline’s remote execution.</li></ul><h2 id=sdks>SDKs</h2><p>Find status and reference information on all of the available Beam SDKs.</p><div class=sdks><ul><li class=item-description><a href=/documentation/sdks/java/>Java SDK</a></li><li class=item-description><a href=/documentation/sdks/python/>Python SDK</a></li><li class=item-description><a href=/documentation/sdks/go/>Go SDK</a></li></ul></div><h2 id=transform-catalogs>Transform catalogs</h2><p>Beam’s transform ca [...] built-in transforms.</p><ul><li><a href=/documentation/transforms/java/overview/>Java transform catalog</a></li><li><a href=/documentation/transforms/python/overview/>Python transform catalog</a></li></ul><h2 id=runners>Runners</h2><p>A Beam Runner runs a Beam pipeline on a specific (often distributed) data processing system.</p><h3 id=available-runners>Available Runners</h3><div class="documentation-list mobile-column"><div class=row><div class=column><div class=item-icon><svg width="67" height="84" viewBox="0 0 67 84" fill="none" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><rect x=".500977" y=".450195" width="188.235" height="83.4223" fill="url(#pattern5)"/><defs><pattern id="pattern5" patternContentUnits="objectBoundingBox" width="1" height="1"><use xlin [...] However, given every runner has different capabilities, they also have different diff --git a/website/generated-content/sitemap.xml b/website/generated-content/sitemap.xml index ae28a81a05e..afd5af8632f 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>/case-studies/octo/</loc><lastmod>2023-08-25T23:36:28+09:00</lastmod></url><url><loc>/blog/beam-2.49.0/</loc><lastmod>2023-08-25T23:36:28+09:00</lastmod></url><url><loc>/categories/blog/</loc><lastmod>2023-08-25T23:36:28+09:00</lastmod></url><url><loc>/blog/</loc><lastmod>2023-08-25T23:36:28+09:00</lastmod></url><url><loc> [...] \ 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>/case-studies/octo/</loc><lastmod>2023-08-25T14:32:31-07:00</lastmod></url><url><loc>/blog/beam-2.49.0/</loc><lastmod>2023-08-25T14:32:31-07:00</lastmod></url><url><loc>/categories/blog/</loc><lastmod>2023-08-25T14:32:31-07:00</lastmod></url><url><loc>/blog/</loc><lastmod>2023-08-25T14:32:31-07:00</lastmod></url><url><loc> [...] \ No newline at end of file