Skip to content

Commit 06dd70f

Browse files
author
committed
Deployed 7e7de6f with MkDocs version: 1.6.1
1 parent f188c61 commit 06dd70f

2 files changed

Lines changed: 35 additions & 37 deletions

File tree

community/project-management/index.html

Lines changed: 34 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2852,45 +2852,43 @@ <h4 id="responsibilities">Responsibilities<a class="headerlink" href="#responsib
28522852
<hr />
28532853
<h2 id="release-process">Release process<a class="headerlink" href="#release-process" title="Permanent link">&para;</a></h2>
28542854
<ul>
2855-
<li>The release manager is selected by <code>@tomchristie</code>.</li>
2855+
<li>The release manager is selected.</li>
28562856
<li>The release manager will then have the maintainer role added to PyPI package.</li>
28572857
<li>The previous manager will then have the maintainer role removed from the PyPI package.</li>
28582858
</ul>
2859-
<p>Our PyPI releases will be handled by either the current release manager, or by <code>@tomchristie</code>. Every release should have an open issue tagged with the <code>Release</code> label and marked against the appropriate milestone.</p>
2860-
<p>The following template should be used for the description of the issue, and serves as a release checklist.</p>
2861-
<div class="language-text highlight"><pre><span></span><code>Release manager is @***.
2862-
Pull request is #***.
2863-
2864-
Checklist:
2865-
2866-
- [ ] Create pull request for [release notes](https://github.com/encode/django-rest-framework/blob/mains/docs/topics/release-notes.md):
2867-
- Start drafting a new release in GitHub: https://github.com/encode/django-rest-framework/releases/new
2868-
- Select the tag that you want to give to the next release and the previous tag
2869-
- Click the &quot;Generate release notes&quot; button
2870-
- Don&#39;t confirm anything yet! Copy the generated content to a file `input.md`
2871-
- Run `uv tool run linkify-gh-markdown input.md` to make the links absolute
2872-
- Put the generated content in the release-notes.md file
2873-
- [ ] Update supported versions:
2874-
- [ ] `pyproject.toml` `python_requires` list
2875-
- [ ] `pyproject.toml` Python &amp; Django version trove classifiers
2876-
- [ ] `README` Python &amp; Django versions
2877-
- [ ] `docs` Python &amp; Django versions
2878-
- [ ] Ensure the pull request increments the version to `*.*.*` in [`restframework/__init__.py`](https://github.com/encode/django-rest-framework/blob/main/rest_framework/__init__.py).
2879-
- [ ] Ensure documentation validates
2880-
- Build and serve docs `mkdocs serve`
2881-
- Validate links `pylinkvalidate.py -P http://127.0.0.1:8000`
2882-
- [ ] Confirm with other maintainers that the release is finalized and ready to go.
2883-
- [ ] Ensure that release date is included in pull request.
2884-
- [ ] Merge the release pull request.
2885-
- [ ] Tag the release, either with `git tag -a *.*.* -m &#39;version *.*.*&#39;; git push --tags` or in GitHub.
2886-
- [ ] Wait for the release workflow to run. It will build the distribution, upload it to Test PyPI, PyPI and create the GitHub release.
2887-
- [ ] Make a release announcement on the [discussion group](https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework).
2888-
- [ ] Make a release announcement on social media (Mastodon, etc...) and on the [Django forum](https://forum.djangoproject.com/).
2889-
- [ ] Close the milestone on GitHub.
2890-
2891-
To modify this process for future releases make a pull request to the [project management](https://www.django-rest-framework.org/topics/project-management/) documentation.
2892-
</code></pre></div>
2893-
<p>When pushing the release to PyPI ensure that your environment has been installed from our development <code>requirement.txt</code>, so that documentation and PyPI installs are consistently being built against a pinned set of packages.</p>
2859+
<p>Our PyPI releases is automated in GitHub actions on tag pushes. The following template can be used as a release checklist:</p>
2860+
<ul>
2861+
<li>Create pull request for <a href="https://github.com/encode/django-rest-framework/blob/mains/docs/topics/release-notes.md">release notes</a>:<ul>
2862+
<li>Start drafting a <a href="https://github.com/encode/django-rest-framework/releases/new">new release in GitHub</a></li>
2863+
<li>Select the tag that you want to give to the release and the previous tag</li>
2864+
<li>Click the "Generate release notes" button</li>
2865+
<li>Don't confirm anything! Copy the generated content to a file <code>input.md</code></li>
2866+
<li>Run <code>uv tool run linkify-gh-markdown input.md</code> to make the links absolute</li>
2867+
<li>Put the generated content in the <code>release-notes.md</code> file</li>
2868+
</ul>
2869+
</li>
2870+
<li>Update supported versions:<ul>
2871+
<li><code>pyproject.toml</code> <code>python_requires</code> list</li>
2872+
<li><code>pyproject.toml</code> Python &amp; Django version trove classifiers</li>
2873+
<li><code>README</code> Python &amp; Django versions</li>
2874+
<li><code>docs</code> Python &amp; Django versions</li>
2875+
</ul>
2876+
</li>
2877+
<li>Ensure the pull request increments the version to <code>*.*.*</code> in <a href="https://github.com/encode/django-rest-framework/blob/main/rest_framework/__init__.py"><code>restframework/__init__.py</code></a>.</li>
2878+
<li>Ensure documentation validates<ul>
2879+
<li>Build and serve docs <code>mkdocs serve</code></li>
2880+
<li>Validate links <code>pylinkvalidate.py -P http://127.0.0.1:8000</code></li>
2881+
</ul>
2882+
</li>
2883+
<li>Confirm with other maintainers that the release is finalized and ready to go.</li>
2884+
<li>Ensure that release date is included in pull request.</li>
2885+
<li>Merge the release pull request.</li>
2886+
<li>Tag the release, either with <code>git tag -a *.*.* -m 'version *.*.*'; git push --tags</code> or in GitHub.</li>
2887+
<li>Wait for the release workflow to run. It will build the distribution, upload it to Test PyPI, PyPI and create the GitHub release.</li>
2888+
<li>Make a release announcement on the <a href="https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework">discussion group</a>.</li>
2889+
<li>Make a release announcement on social media (Mastodon, etc...) and on the <a href="https://forum.djangoproject.com/">Django forum</a>.</li>
2890+
<li>Close the milestone on GitHub.</li>
2891+
</ul>
28942892
<hr />
28952893
<h2 id="project-ownership">Project ownership<a class="headerlink" href="#project-ownership" title="Permanent link">&para;</a></h2>
28962894
<p>The PyPI package is owned by <code>@tomchristie</code>. As a backup <code>@j4mie</code> also has ownership of the package.</p>

search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)