This is an automated email from the ASF dual-hosted git repository. srowen pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/spark-website.git
The following commit(s) were added to refs/heads/asf-site by this push: new d0a3ad9fe5 Improve instructions for the release process d0a3ad9fe5 is described below commit d0a3ad9fe57a07640160ad88b98c0c5e44eec303 Author: Xinrong Meng <xinr...@apache.org> AuthorDate: Sat Apr 15 14:22:51 2023 -0500 Improve instructions for the release process Improve instructions for the release process, specifically, the `Finalize the release` step. That includes - point out which steps have been automated - details to pay attention to - typo fixing - more clear steps by naming Author: Xinrong Meng <xinr...@apache.org> Closes #454 from xinrong-meng/release-process. --- release-process.md | 26 ++++++++++++++++++++++---- site/release-process.html | 28 ++++++++++++++++++++++++---- 2 files changed, 46 insertions(+), 8 deletions(-) diff --git a/release-process.md b/release-process.md index 2133010840..4030352f8b 100644 --- a/release-process.md +++ b/release-process.md @@ -186,6 +186,18 @@ that looks something like `[VOTE][RESULT] ...`. <h3>Finalize the release</h3> +Note that `dev/create-release/do-release-docker.sh` script (`finalize` step ) automates most of the following steps **except** for: +- Publish to CRAN +- Update the configuration of Algolia Crawler +- Remove old releases from Mirror Network +- Update the rest of the Spark website +- Create and upload Spark Docker Images +- Create an announcement + +Please manually verify the result after each step. + +<h4>Upload to Apache release directory</h4> + **Be Careful!** **THIS STEP IS IRREVERSIBLE so make sure you selected the correct staging repository. Once you @@ -237,7 +249,7 @@ Publishing to CRAN is done using <a href="https://cran.r-project.org/submit.html Since it requires further manual steps, please also contact the <a href="mailto:priv...@spark.apache.org">PMC</a>. -<h4> Remove RC artifacts from repositories</h4> +<h4>Remove RC artifacts from repositories</h4> After the vote passes and you moved the approved RC to the release repository, you should delete the RC directories from the staging repository. For example: @@ -279,6 +291,8 @@ The search box on the <a href="https://spark.apache.org/docs/latest/">Spark docu <h4>Update the Spark website</h4> +<h5>Upload generated docs</h5> + The website repository is located at <a href="https://github.com/apache/spark-website">https://github.com/apache/spark-website</a>. @@ -297,17 +311,19 @@ $ git clone https://github.com/apache/spark-website $ cp -R _site spark-website/site/docs/1.1.1 # Update the "latest" link -$ cd spark/site/docs +$ cd spark-website/site/docs $ rm latest $ ln -s 1.1.1 latest ``` +<h5>Update the rest of the Spark website</h5> + Next, update the rest of the Spark website. See how the previous releases are documented (all the HTML file changes are generated by `jekyll`). In particular: * update `_layouts/global.html` if the new release is the latest one * update `documentation.md` to add link to the docs for the new release -* add the new release to `js/downloads.js` +* add the new release to `js/downloads.js` (attention to the order of releases) * check `security.md` for anything to update ``` @@ -324,6 +340,8 @@ be the date you create it. Then run `bundle exec jekyll build` to update the `site` directory. +Considering the Pull Request will be large, please separate the commits of code changes and generated `site` directory for an easier review. + After merging the change into the `asf-site` branch, you may need to create a follow-up empty commit to force synchronization between ASF's git and the web site, and also the GitHub mirror. For some reason synchronization seems to not be reliable for this repository. @@ -393,7 +411,7 @@ Once you have your cross-platform docker build environment setup, extract the bu <h4>Create an announcement</h4> Once everything is working (website docs, website changes) create an announcement on the website -and then send an e-mail to the mailing list. To create an announcement, create a post under +and then send an e-mail to the mailing list with a subject that looks something like `[ANNOUNCE] ...`. To create an announcement, create a post under `news/_posts` and then run `bundle exec jekyll build`. Enjoy an adult beverage of your choice, and congratulations on making a Spark release. diff --git a/site/release-process.html b/site/release-process.html index 263ba6431e..72d6bd7982 100644 --- a/site/release-process.html +++ b/site/release-process.html @@ -310,6 +310,20 @@ that looks something like <code class="language-plaintext highlighter-rouge">[VO <h3>Finalize the release</h3> +<p>Note that <code class="language-plaintext highlighter-rouge">dev/create-release/do-release-docker.sh</code> script (<code class="language-plaintext highlighter-rouge">finalize</code> step ) automates most of the following steps <strong>except</strong> for:</p> +<ul> + <li>Publish to CRAN</li> + <li>Update the configuration of Algolia Crawler</li> + <li>Remove old releases from Mirror Network</li> + <li>Update the rest of the Spark website</li> + <li>Create and upload Spark Docker Images</li> + <li>Create an announcement</li> +</ul> + +<p>Please manually verify the result after each step.</p> + +<h4>Upload to Apache release directory</h4> + <p><strong>Be Careful!</strong></p> <p><strong>THIS STEP IS IRREVERSIBLE so make sure you selected the correct staging repository. Once you @@ -355,7 +369,7 @@ is incorrect (e.g. http failure or other issue), you can rename the artifact to <p>Publishing to CRAN is done using <a href="https://cran.r-project.org/submit.html">this form</a>. Since it requires further manual steps, please also contact the <a href="mailto:priv...@spark.apache.org">PMC</a>.</p> -<h4> Remove RC artifacts from repositories</h4> +<h4>Remove RC artifacts from repositories</h4> <p>After the vote passes and you moved the approved RC to the release repository, you should delete the RC directories from the staging repository. For example:</p> @@ -392,6 +406,8 @@ $ git push apache v1.1.1 <h4>Update the Spark website</h4> +<h5>Upload generated docs</h5> + <p>The website repository is located at <a href="https://github.com/apache/spark-website">https://github.com/apache/spark-website</a>.</p> @@ -409,18 +425,20 @@ $ git clone https://github.com/apache/spark-website $ cp -R _site spark-website/site/docs/1.1.1 # Update the "latest" link -$ cd spark/site/docs +$ cd spark-website/site/docs $ rm latest $ ln -s 1.1.1 latest </code></pre></div></div> +<h5>Update the rest of the Spark website</h5> + <p>Next, update the rest of the Spark website. See how the previous releases are documented (all the HTML file changes are generated by <code class="language-plaintext highlighter-rouge">jekyll</code>). In particular:</p> <ul> <li>update <code class="language-plaintext highlighter-rouge">_layouts/global.html</code> if the new release is the latest one</li> <li>update <code class="language-plaintext highlighter-rouge">documentation.md</code> to add link to the docs for the new release</li> - <li>add the new release to <code class="language-plaintext highlighter-rouge">js/downloads.js</code></li> + <li>add the new release to <code class="language-plaintext highlighter-rouge">js/downloads.js</code> (attention to the order of releases)</li> <li>check <code class="language-plaintext highlighter-rouge">security.md</code> for anything to update</li> </ul> @@ -437,6 +455,8 @@ be the date you create it.</p> <p>Then run <code class="language-plaintext highlighter-rouge">bundle exec jekyll build</code> to update the <code class="language-plaintext highlighter-rouge">site</code> directory.</p> +<p>Considering the Pull Request will be large, please separate the commits of code changes and generated <code class="language-plaintext highlighter-rouge">site</code> directory for an easier review.</p> + <p>After merging the change into the <code class="language-plaintext highlighter-rouge">asf-site</code> branch, you may need to create a follow-up empty commit to force synchronization between ASF’s git and the web site, and also the GitHub mirror. For some reason synchronization seems to not be reliable for this repository.</p> @@ -501,7 +521,7 @@ $ git log v1.1.1 --grep "$expr" --shortstat --oneline | grep -B 1 -e "[3-9][0-9] <h4>Create an announcement</h4> <p>Once everything is working (website docs, website changes) create an announcement on the website -and then send an e-mail to the mailing list. To create an announcement, create a post under +and then send an e-mail to the mailing list with a subject that looks something like <code class="language-plaintext highlighter-rouge">[ANNOUNCE] ...</code>. To create an announcement, create a post under <code class="language-plaintext highlighter-rouge">news/_posts</code> and then run <code class="language-plaintext highlighter-rouge">bundle exec jekyll build</code>.</p> <p>Enjoy an adult beverage of your choice, and congratulations on making a Spark release.</p> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org