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
Copy file name to clipboardExpand all lines: content/contributing/release.md
+12-21Lines changed: 12 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ tests pass, and that the build passes, by looking at the standard PR checks UI.
73
73
1. Check out the `main` or `stable` branch depending on what release you're
74
74
making.
75
75
2. Check out a new branch with the name `release-A.B.C`, for example
76
-
`release-{3.2.0}`.
76
+
`release-3.2.0`.
77
77
3. Update `CHANGES.md` to change `Unreleased` to `Released YYYY-MM-DD`, for
78
78
example `Released 2024-08-04`.
79
79
4. Update `pyproject.toml` to change `[project].version`, removing the `.dev`
@@ -93,10 +93,9 @@ start the build process by pushing a tag.
93
93
94
94
The `publish.yaml` workflow will start to run and you'll see build-related
95
95
checks show up in the PR checks UI. First, it builds the sdist and wheel. Then
96
-
it generates an SLSA attestation for those files. Then it creates a draft
97
-
release and uploads the build and attestation file to it. Finally, you'll see it
98
-
waiting for approval to upload to PyPI. Don't approve it yet, there's more to do
99
-
first.
96
+
it creates a draftrelease and uploads the built files to it. Finally, you'll
97
+
see it waiting for approval to upload to PyPI. Don't approve it yet, there's
98
+
more to do first.
100
99
101
100
## Prepare the Release Message
102
101
@@ -116,37 +115,29 @@ format:
116
115
For feature releases, the explanation is:
117
116
118
117
```markdown
119
-
This is the {project} {version} feature release. A feature release may include
120
-
new features, remove previously deprecated code, add new deprecations, or
121
-
introduce potentially breaking changes.
118
+
This is the {project} {version} feature release. A feature release may include new features, remove previously deprecated code, add new deprecations, or introduce potentially breaking changes.
122
119
123
-
We encourage everyone to upgrade. You can read more about our
124
-
[Version Support Policy][version] on our website.
120
+
We encourage everyone to upgrade. You can read more about our [Version Support Policy][version] on our website.
Please remember, applications _must_ lock their full dependency tree to control
135
-
when updates are installed and ensure reproducible deployments. Use one of the
136
-
various project management or lock tools available in the Python ecosystem. Test
137
-
with warnings treated as errors to be able to adapt to deprecation warnings early.
130
+
Please remember, applications _must_ lock their full dependency tree to control when updates are installed and ensure reproducible deployments. Use one of the various project management or lock tools available in the Python ecosystem. Test with warnings treated as errors to be able to adapt to deprecation warnings early.
138
131
```
139
132
140
133
For fix releases, the explanation is:
141
134
142
135
```markdown
143
-
This is the {project} {version} fix release, which fixes bugs but does not
144
-
otherwise change behavior and should not result in breaking changes compared to
145
-
the latest feature release.
136
+
This is the {project} {version} fix release, which fixes bugs but does not otherwise change behavior and should not result in breaking changes compared to the latest feature release.
0 commit comments