You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2023/10/10 07:26:11 UTC
[logging-parent] branch asf-site updated: Add website-specific release instructions
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/logging-parent.git
The following commit(s) were added to refs/heads/asf-site by this push:
new fe3446b Add website-specific release instructions
fe3446b is described below
commit fe3446ba6abd163f1430b0fd8019f9934047699d
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Tue Oct 10 09:24:45 2023 +0200
Add website-specific release instructions
---
10.x/index.html | 156 ++++++++++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 136 insertions(+), 20 deletions(-)
diff --git a/10.x/index.html b/10.x/index.html
index d120b93..5ae30c0 100644
--- a/10.x/index.html
+++ b/10.x/index.html
@@ -553,8 +553,10 @@ table.CodeRay td.code{padding:0 0 0 .75em}
<li><a href="#release-instructions">Release instructions</a>
<ul class="sectlevel2">
<li><a href="#stage-release">Stage the release</a></li>
+<li><a href="#stage-release-website">Stage the release website</a></li>
<li><a href="#vote-release">Vote the release</a></li>
<li><a href="#publish-release">Publish the release</a></li>
+<li><a href="#publish-release-website">Publish the release website</a></li>
<li><a href="#announce-release">Announce the release</a></li>
</ul>
</li>
@@ -1000,6 +1002,21 @@ git checkout -B release/7.8.0 origin/main
git push origin release/7.8.0</code></pre>
</div>
</div>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-tip" title="Tip"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p><code>release/</code>-prefixed branches trigger a particular GitHub Actions workflow and its run is idempotent.
+You can iterate on the <code>release/7.8.0</code> branch to perfect it.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
</li>
<li>
<p>Verify that the associated <a href="https://github.com/apache/logging-parent/actions">GitHub Actions workflow</a> succeeds:</p>
@@ -1016,33 +1033,56 @@ git push origin release/7.8.0</code></pre>
</li>
<li>
<p><strong>Signed distribution and its checksum</strong> (e.g., <code>apache-logging-parent-7.8.0-{bin,src}.{zip,.zip.asc,.zip.sha512}</code>) are uploaded to <a href="https://dist.apache.org/repos/dist/dev/logging/logging-parent">dist.apache.org/repos/dist/<strong>dev</strong>/logging/logging-parent</a> Subversion repository (along with auxiliary files; website, email texts, etc.)</p>
+</li>
+</ol>
+</div>
<div class="paragraph">
<p>If not, commit necessary fixes, push, and repeat.</p>
</div>
</li>
+<li>
+<p><em>Close</em> the repository in <a href="https://repository.apache.org/">repository.apache.org</a></p>
+</li>
</ol>
</div>
-<div class="admonitionblock tip">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-tip" title="Tip"></i>
-</td>
-<td class="content">
-<div class="paragraph">
-<p>GitHub Actions workflow is idempotent.
-You can iterate on the <code>release/7.8.0</code> branch to perfect it.</p>
-</div>
-</td>
-</tr>
-</table>
</div>
+<div class="sect2">
+<h3 id="stage-release-website">Stage the release website</h3>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Checkout the <code>asf-staging</code> branch of <a href="https://github.com/apache/logging-parent">the website repository</a></p>
</li>
<li>
-<p><em>Close</em> the repository in <a href="https://repository.apache.org/">repository.apache.org</a></p>
+<p>Override the contents of the <code>7.x</code> folder using the website uploaded to the <a href="https://dist.apache.org/repos/dist/dev/logging/logging-parent">dist.apache.org/repos/dist/<strong>dev</strong>/logging/logging-parent</a> Subversion repository</p>
</li>
</ol>
</div>
+<div class="paragraph">
+<p>These steps can be summarized as follows in shell:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash"># Clone repositories (unless you already have them!)
+svn co https://dist.apache.org/repos/dist/dev/logging logging-dist-dev
+git clone https://github.com/apache/logging-parent logging-parent
+
+# Checkout the branch
+cd logging-parent
+git checkout -B asf-staging origin/asf-staging
+
+# Override the website
+git rm -rf 7.x
+mkdir 7.x
+unzip ../logging-dist-dev/logging-parent/*-7.8.0-site.zip -d 7.x
+git add 7.x
+git commit -a -m 'Add `logging-parent` version `7.8.0` website'
+git push origin asf-staging</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Changes should be visible in <a href="https://logging.staged.apache.org/logging-parent">the project <strong>staging</strong> website</a>.</p>
+</div>
</div>
<div class="sect2">
<h3 id="vote-release">Vote the release</h3>
@@ -1144,7 +1184,8 @@ git push origin rel/7.8.0</code></pre>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="bash">git checkout main
-git merge release/7.8.0</code></pre>
+git rebase origin/main # Sync with the remote repository
+git merge rel/7.8.0 # Pull changes up to the newly created tag</code></pre>
</div>
</div>
</li>
@@ -1156,6 +1197,12 @@ git merge release/7.8.0</code></pre>
</li>
<li>
<p>Delete the local and remote copies of the <code>release/7.8.0</code> branch</p>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash">git branch -D release/7.8.0
+git push --delete origin release/7.8.0</code></pre>
+</div>
+</div>
</li>
</ol>
</div>
@@ -1175,13 +1222,45 @@ git merge release/7.8.0</code></pre>
<p>create the <code><strong>release</strong>/logging/logging-parent/7.8.0</code> folder, and copy the signed sources and their checksum from <code><strong>dev</strong>/logging/logging-parent</code> to there</p>
</li>
<li>
-<p>delete the folder from an earlier release in <code><strong>release</strong>/logging/logging-parent</code> (stash the generated announcement email somewhere, you will need it later on)</p>
+<p>delete the folder from an earlier release in <code><strong>release</strong>/logging/logging-parent</code></p>
+</li>
+<li>
+<p>commit your changes in <code><strong>release</strong>/logging/logging-parent</code></p>
+</li>
+<li>
+<p>delete the <code><strong>dev</strong>/logging/logging-parent</code> folder (stash the generated announcement email somewhere, you will need it later on)</p>
</li>
<li>
-<p>commit changes</p>
+<p>commit changes your changes in <code><strong>dev</strong>/logging/logging-parent</code></p>
</li>
</ol>
</div>
+<div class="openblock">
+<div class="content">
+<div class="paragraph">
+<p>These steps can be summarized as follows in shell:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash"># Clone repositories (unless you already have them!)
+svn co https://dist.apache.org/repos/dist/dev/logging logging-dist-dev
+svn co https://dist.apache.org/repos/dist/release/logging logging-dist-rel
+
+# Update `release` folder
+cd logging-dist-rel
+mkdir -p logging-parent/7.8.0
+cp ../logging-dist-dev/logging-parent/*-7.8.0-{bin,src}.* logging-parent/7.8.0/
+svn commit -m 'Add `logging-parent` version `7.8.0` distribution'
+
+# Update `dev` folder
+cd logging-dist-dev
+cp logging-parent/*-7.8.0-email-announce.txt /tmp
+svn rm logging-parent
+svn commit -m 'Remove `logging-parent` version `7.8.0` files released'</code></pre>
+</div>
+</div>
+</div>
+</div>
</li>
<li>
<p>Report the release at <a href="https://reporter.apache.org/addrelease.html?logging">reporter.apache.org</a></p>
@@ -1192,7 +1271,7 @@ git merge release/7.8.0</code></pre>
<div class="sect3">
<h4 id="publish-release-github">In GitHub</h4>
<div class="paragraph">
-<p>Once the artifacts are visible in <a href="https://central.sonatype.dev/">central.sonatype.dev</a>, <a href="https://github.com/apache/logging-parent/releases/new">create a new release in GitHub</a></p>
+<p><a href="https://github.com/apache/logging-parent/releases/new">Create a new release in GitHub</a></p>
</div>
<div class="olist arabic">
<ol class="arabic">
@@ -1207,6 +1286,43 @@ git merge release/7.8.0</code></pre>
</div>
</div>
<div class="sect2">
+<h3 id="publish-release-website">Publish the release website</h3>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Checkout the <code>asf-site</code> branch of <a href="https://github.com/apache/logging-parent">the website repository</a></p>
+</li>
+<li>
+<p>Replace the <code>7.x</code> folder with the one in <code>asf-staging</code> branch</p>
+</li>
+</ol>
+</div>
+<div class="paragraph">
+<p>These steps can be summarized as follows in shell:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash"># Clone the repository (unless you already have it!)
+git clone https://github.com/apache/logging-parent logging-parent
+
+# Checkout the branch
+cd logging-parent
+git checkout -B asf-site origin/asf-site
+
+# Override the website
+git rm -rf 7.x
+mkdir 7.x
+git checkout asf-staging -- 7.x
+git add 7.x
+git commit -a -m 'Add `logging-parent` version `7.8.0` website'
+git push origin asf-site</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Changes should be visible in <a href="https://logging.apache.org/logging-parent">the project website</a>.</p>
+</div>
+</div>
+<div class="sect2">
<h3 id="announce-release">Announce the release</h3>
<div class="olist arabic">
<ol class="arabic">
@@ -1251,7 +1367,7 @@ See the License for the specific language governing permissions and limitations
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2023-10-02 08:53:56 UTC
+Last updated 2023-09-27 11:41:26 +0200
</div>
</div>
</body>