docs: update releasing process to use new scripts and gitlab
There were several out of date entries in this document, update them to current practices. Reviewed-by: Juan A. Suarez <jasuarez@igalia.com>
This commit is contained in:
parent
8a4541aae2
commit
ca0c1e69ca
|
@ -26,8 +26,7 @@
|
||||||
<li><a href="#prerelease">Pre-release announcement</a>
|
<li><a href="#prerelease">Pre-release announcement</a>
|
||||||
<li><a href="#release">Making a new release</a>
|
<li><a href="#release">Making a new release</a>
|
||||||
<li><a href="#announce">Announce the release</a>
|
<li><a href="#announce">Announce the release</a>
|
||||||
<li><a href="#website">Update the mesa3d.org website</a>
|
<li><a href="#gitlab">Update Gitlab Issues</a>
|
||||||
<li><a href="#bugzilla">Update Bugzilla</a>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
@ -517,6 +516,16 @@ So we do a quick 'touch test'
|
||||||
unset VK_ICD_FILENAMES
|
unset VK_ICD_FILENAMES
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
|
<h3>Create release notes for the new release</h3>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
The release notes are completely generated by the
|
||||||
|
<pre>bin/gen_release_notes.py</pre> script. Simply run this script before
|
||||||
|
bumping the version
|
||||||
|
|
||||||
|
The only thing left to do is add the sha256 sums.
|
||||||
|
</p>
|
||||||
|
|
||||||
<h3>Update version in file VERSION</h3>
|
<h3>Update version in file VERSION</h3>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
|
@ -524,30 +533,6 @@ Increment the version contained in the file VERSION at Mesa's top-level, then
|
||||||
commit this change.
|
commit this change.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h3>Create release notes for the new release</h3>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
Create a new file docs/relnotes/X.Y.Z.html, (follow the style of the previous
|
|
||||||
release notes). Note that the sha256sums section of the release notes should
|
|
||||||
be empty (TBD) at this point.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
Two scripts are available to help generate portions of the release notes:
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
./bin/bugzilla_mesa.sh
|
|
||||||
./bin/shortlog_mesa.sh
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
The first script identifies commits that reference bugzilla bugs and obtains
|
|
||||||
the descriptions of those bugs from bugzilla. The second script generates a
|
|
||||||
log of all commits. In both cases, HTML-formatted lists are printed to stdout
|
|
||||||
to be included in the release notes.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
Commit these changes and push the branch.
|
Commit these changes and push the branch.
|
||||||
</p>
|
</p>
|
||||||
|
@ -591,11 +576,9 @@ Something like the following steps will do the trick:
|
||||||
git cherry-pick -x X.Y
|
git cherry-pick -x X.Y
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
<p>
|
<p>Then run the <pre>./bin/post_verison.py X.Y.Z</pre>, where X.Y.Z is the
|
||||||
Also, edit docs/relnotes.html to add a link to the new release notes,
|
version you just made. This will updated docs/relnotes.html and
|
||||||
edit docs/index.html to add a news entry and a note in case of the
|
docs/index.html. Remove docs/release-calendar.html. Then commit and push:
|
||||||
last release in a series, and remove the version from
|
|
||||||
docs/release-calendar.html. Then commit and push:
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
|
@ -616,15 +599,7 @@ series, if that is the case.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
<h2 id="website">Update the mesa3d.org website</h2>
|
<h2 id="gitlab">Update gitlab issues</h2>
|
||||||
|
|
||||||
<p>
|
|
||||||
As the hosting was moved to freedesktop, git hooks are deployed to update the
|
|
||||||
website. Manually check that it is updated 5-10 minutes after the final <code>git push</code>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
|
|
||||||
<h2 id="bugzilla">Update Bugzilla</h2>
|
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
Parse through the bugreports as listed in the docs/relnotes/X.Y.Z.html
|
Parse through the bugreports as listed in the docs/relnotes/X.Y.Z.html
|
||||||
|
|
Loading…
Reference in New Issue