Skip to content

Commit dbf480d

Browse files
authored
Update release.md
1 parent 8877b42 commit dbf480d

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

content/contributing/release.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ tests pass, and that the build passes, by looking at the standard PR checks UI.
7373
1. Check out the `main` or `stable` branch depending on what release you're
7474
making.
7575
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`.
7777
3. Update `CHANGES.md` to change `Unreleased` to `Released YYYY-MM-DD`, for
7878
example `Released 2024-08-04`.
7979
4. Update `pyproject.toml` to change `[project].version`, removing the `.dev`
@@ -93,10 +93,9 @@ start the build process by pushing a tag.
9393

9494
The `publish.yaml` workflow will start to run and you'll see build-related
9595
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.
10099

101100
## Prepare the Release Message
102101

@@ -116,37 +115,29 @@ format:
116115
For feature releases, the explanation is:
117116

118117
```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.
122119

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.
125121

126122
[version]: https://palletsprojects.com/versions
127123

128124
PyPI: https://pypi.org/project/{pypi name}/{version}/
129-
Changes: https://{project}.readthedocs.io/en/stable/changes/#version-{A-B-C}
130-
Milestone https://github.com/pallets-eco/{project}/milestones/{milestone}?closed=1
125+
Changes: https://{project}.readthedocs.io/page/changes/#version-{A-B-C}
126+
Milestone https://github.com/pallets-eco/{project}/milestone/{milestone}?closed=1
131127

132128
{change entries, markdown, replace links}
133129

134-
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.
138131
```
139132

140133
For fix releases, the explanation is:
141134

142135
```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.
146137

147138
PyPI: https://pypi.org/project/{pypi name}/{version}/
148-
Changes: https://{project}.readthedocs.io/en/stable/changes/#version-{A-B-C}
149-
Milestone https://github.com/pallets-eco/{project}/milestones/{milestone}?closed=1
139+
Changes: https://{project}.readthedocs.io/page/changes/#version-{A-B-C}
140+
Milestone https://github.com/pallets-eco/{project}/milestone/{milestone}?closed=1
150141

151142
{change entries, markdown, replace links}
152143
```

0 commit comments

Comments
 (0)