You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by gi...@apache.org on 2022/06/15 13:56:41 UTC
[iceberg-docs] branch asf-site updated: deploy: 3c3d40dd78edf98058f18e1c62967662fdf99c31
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/iceberg-docs.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 7484f28 deploy: 3c3d40dd78edf98058f18e1c62967662fdf99c31
7484f28 is described below
commit 7484f28a141a9e7188da18d411f976205f238066
Author: RussellSpitzer <Ru...@users.noreply.github.com>
AuthorDate: Wed Jun 15 13:56:37 2022 +0000
deploy: 3c3d40dd78edf98058f18e1c62967662fdf99c31
---
how-to-release/index.html | 34 ++++++++++++++++++----------------
1 file changed, 18 insertions(+), 16 deletions(-)
diff --git a/how-to-release/index.html b/how-to-release/index.html
index a6fe1e1..1591c3b 100644
--- a/how-to-release/index.html
+++ b/how-to-release/index.html
@@ -108,7 +108,7 @@ The email template is already generated in <code>release-announcement-email.txt<
</span></span><span style=display:flex><span>svn ci -m <span style=color:#e6db74>'Iceberg: Add release <VERSION>'</span>
</span></span></code></pre></div><p>Next, add a release tag to the git repository based on the passing candidate tag:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span>git tag -am <span style=color:#e6db74>'Release Apache Iceberg <VERSION>'</span> apache-iceberg-<VERSION> apache-iceberg-<VERSION>-rcN
</span></span></code></pre></div><p>Then release the candidate repository in <a href=https://repository.apache.org/#stagingRepositories>Nexus</a>.</p><p>To announce the release, wait until Maven central has mirrored the Apache binaries, then update the Iceberg site and send an announcement email:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-text data-lang=text><span style=display:flex><s [...]
-</span></span></code></pre></div><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-text data-lang=text><span style=display:flex><span>I'm please to announce the release of Apache Iceberg <VERSION>!
+</span></span></code></pre></div><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-text data-lang=text><span style=display:flex><span>I'm pleased to announce the release of Apache Iceberg <VERSION>!
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span>Apache Iceberg is an open table format for huge analytic datasets. Iceberg
</span></span><span style=display:flex><span>delivers high query performance for tables with tens of petabytes of data,
@@ -120,21 +120,23 @@ The email template is already generated in <code>release-announcement-email.txt<
</span></span><span style=display:flex><span>Java artifacts are available from Maven Central.
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span>Thanks to everyone for contributing!
-</span></span></code></pre></div><h3 id=documentation-release>Documentation Release</h3><p>Documentation needs to be updated as a part of Iceberg release after a release candidate is passed.
-The commands described below assume the <code>iceberg-docs</code> repository and <code>iceberg</code> repository are in the same parent directory locally,
-and the release manager is executing commands in the <code>iceberg</code> repository.
-Adjust the commands accordingly if it is not the case.</p><h4 id=iceberg-repository-preparations>iceberg repository preparations</h4><p>A PR needs to be published in <code>iceberg</code> repository with the following changes:</p><ol><li>Mark the current latest release notes to past releases</li><li>Update the latest artifact links in the release notes page</li><li>Add release notes for the new release version</li><li>Create new folder called <code>docs/versioned/releases/<VERSION NUMB [...]
-</span></span><span style=display:flex><span>rm -rf ../iceberg-docs/landing-page/content/common
-</span></span><span style=display:flex><span>cp -r docs/versioned ../iceberg-docs/docs/content/docs
-</span></span><span style=display:flex><span>cp -r docs/common ../iceberg-docs/landing-page/content/common
-</span></span></code></pre></div><p>The resulted changes in <code>iceberg-docs</code> should be approved in a separate PR.</p><h4 id=javadoc-update>Javadoc update</h4><p>In the <code>iceberg</code> repository, generate the javadoc for your release and copy it to the <code>javadoc</code> folder in <code>iceberg-docs</code> repo:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data-lang [...]
+</span></span></code></pre></div><h3 id=documentation-release>Documentation Release</h3><p>Documentation needs to be updated as a part of an Iceberg release after a release candidate is passed.
+The commands described below assume you are in a directory containing a local clone of the <code>iceberg-docs</code>
+repository and <code>iceberg</code> repository. Adjust the commands accordingly if it is not the case. Note that all
+changes in <code>iceberg</code> need to happen against the <code>master</code> branch and changes in <code>iceberg-docs</code> need to happen
+against the <code>main</code> branch.</p><h4 id=iceberg-repository-preparations>iceberg repository preparations</h4><p>A PR needs to be published in the <code>iceberg</code> repository with the following changes:</p><ol><li>Create a new folder called <code>docs/releases/<VERSION NUMBER></code> with an <code>_index.md</code> file. See the existing folders under <code>docs/releases</code> for more details.</li></ol><h4 id=common-documentation-update>Common documentation update</h4><ol>< [...]
+</span></span></code></pre></div><ol start=2><li>Change into the <code>iceberg-docs</code> repository and create a branch.</li></ol><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data-lang=shell><span style=display:flex><span>cd ../iceberg-docs
+</span></span><span style=display:flex><span>git checkout -b <BRANCH NAME>
+</span></span></code></pre></div><ol start=3><li>Commit, push, and open a PR against the <code>iceberg-docs</code> repo (<code><BRANCH NAME></code> -> <code>main</code>)</li></ol><h4 id=versioned-documentation-update>Versioned documentation update</h4><p>Once the common docs changes have been merged into <code>main</code>, the next step is to update the versioned docs.</p><ol><li>In the <code>iceberg-docs</code> repository, cut a new branch using the version number as the branch name< [...]
+</span></span><span style=display:flex><span>git checkout -b <VERSION>
+</span></span><span style=display:flex><span>git push --set-upstream apache <VERSION>
+</span></span></code></pre></div><ol start=2><li>Copy the versioned docs from the <code>iceberg</code> repo into the <code>iceberg-docs</code> repo</li></ol><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data-lang=shell><span style=display:flex><span>cp -r ../iceberg/docs ../iceberg-docs/docs/content/docs
+</span></span></code></pre></div><ol start=3><li>Commit the changes and open a PR against the <code><VERSION></code> branch in the <code>iceberg-docs</code> repo</li></ol><h4 id=javadoc-update>Javadoc update</h4><p>In the <code>iceberg</code> repository, generate the javadoc for your release and copy it to the <code>javadoc</code> folder in <code>iceberg-docs</code> repo:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4 [...]
+</span></span><span style=display:flex><span>./gradlew refreshJavadoc
</span></span><span style=display:flex><span>rm -rf ../iceberg-docs/javadoc
-</span></span><span style=display:flex><span>cp site/docs/javadoc/<VERSION NUMBER> ../iceberg-docs/javadoc
-</span></span></code></pre></div><p>This resulted changes in <code>iceberg-docs</code> should be approved in a separate PR.</p><h4 id=cut-a-new-version-branch>Cut a new version branch</h4><p>Once completed, go to the <code>iceberg-docs</code> repository to cut a new branch using the version number as the branch name.
-For example, to cut a new versioned doc for release <code>0.13.0</code>:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data-lang=shell><span style=display:flex><span>git checkout -b 0.13.0
-</span></span><span style=display:flex><span>git push --set-upstream apache 0.13.0
-</span></span></code></pre></div><h4 id=update-the-latest-branch>Update the latest branch</h4><p>The last step is to point the <code>latest</code> branch to the latest version.
-Because <code>main</code> is currently the same as the version branch, simply rebase <code>latest</code> branch against <code>main</code>:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data-lang=shell><span style=display:flex><span>git checkout latest
+</span></span><span style=display:flex><span>cp -r site/docs/javadoc/<VERSION NUMBER> ../iceberg-docs/javadoc
+</span></span></code></pre></div><p>This resulted changes in <code>iceberg-docs</code> should be approved in a separate PR.</p><h4 id=update-the-latest-branch>Update the latest branch</h4><p>Since <code>main</code> is currently the same as the version branch, one needs to rebase <code>latest</code> branch against <code>main</code>:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data- [...]
</span></span><span style=display:flex><span>git rebase main
</span></span><span style=display:flex><span>git push apache latest
-</span></span></code></pre></div></div></div></body></html>
\ No newline at end of file
+</span></span></code></pre></div><h4 id=set-latest-version-in-iceberg-docs-repo>Set latest version in iceberg-docs repo</h4><p>The last step is to update the <code>main</code> branch in <code>iceberg-docs</code> to set the latest version.
+A PR needs to be published in the <code>iceberg-docs</code> repository with the following changes:</p><ol><li>Update variable <code>latestVersions.iceberg</code> to the new release version in <code>landing-page/config.toml</code></li><li>Update variable <code>latestVersions.iceberg</code> to the new release version in <code>docs/config.toml</code></li><li>Mark the current latest release notes to past releases under <code>landing-page/content/common/release-notes.md</code></li><li>Add rel [...]
\ No newline at end of file