You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<li>The release manager is selected by <code>@tomchristie</code>.</li>
2855
+
<li>The release manager is selected.</li>
2856
2856
<li>The release manager will then have the maintainer role added to PyPI package.</li>
2857
2857
<li>The previous manager will then have the maintainer role removed from the PyPI package.</li>
2858
2858
</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
-
<divclass="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 "Generate release notes" button
2870
-
- Don'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 & Django version trove classifiers
2876
-
- [ ] `README` Python & Django versions
2877
-
- [ ] `docs` Python & 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).
- [ ] 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 'version *.*.*'; 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 <ahref="https://github.com/encode/django-rest-framework/blob/mains/docs/topics/release-notes.md">release notes</a>:<ul>
2862
+
<li>Start drafting a <ahref="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>
<li><code>pyproject.toml</code> Python & Django version trove classifiers</li>
2873
+
<li><code>README</code> Python & Django versions</li>
2874
+
<li><code>docs</code> Python & Django versions</li>
2875
+
</ul>
2876
+
</li>
2877
+
<li>Ensure the pull request increments the version to <code>*.*.*</code> in <ahref="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>
0 commit comments