Skip to content

Commit 6b758fd

Browse files
Update release instructions in README.md (#89)
* Update release instructions in README.md * Update history link. Co-authored-by: Alex Waygood <[email protected]> * Add quotes around our friends projects Co-authored-by: Alex Waygood <[email protected]> * Fix wrong sentence. --------- Co-authored-by: Alex Waygood <[email protected]>
1 parent 4cecfc7 commit 6b758fd

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -108,22 +108,21 @@ $ docutils --writer=pseudoxml tests/fixtures/xpass/role-in-code-sample.rst
108108
109109
## Releasing
110110
111-
First test with friends projects by running:
112-
113-
sh download-more-tests.sh
114-
python -m pytest
115-
116-
Bump the version in `sphinxlint.py`, commit, tag, push:
117-
118-
git tag v0.6.5
119-
git push
120-
git push --tags
121-
122-
To release on PyPI run:
123-
124-
python -m pip install --upgrade build twine
125-
python -m build
126-
python -m twine upload dist/*
111+
1. Make sure that the [CI tests pass](https://github.com/sphinx-contrib/sphinx-lint/actions)
112+
and optionally double-check locally with "friends projects" by running:
113+
114+
sh download-more-tests.sh
115+
python -m pytest
116+
2. Go on the [Releases page](https://github.com/sphinx-contrib/sphinx-lint/releases)
117+
3. Click "Draft a new release"
118+
4. Click "Choose a tag"
119+
5. Type the next vX.Y.Z version and select "Create new tag: vX.Y.Z on publish"
120+
6. Leave the "Release title" blank (it will be autofilled)
121+
7. Click "Generate release notes" and amend as required
122+
8. Click "Publish release"
123+
9. Check the tagged
124+
[GitHub Actions build](https://github.com/sphinx-contrib/sphinx-lint/actions/workflows/deploy.yml)
125+
has [deployed to PyPI](https://pypi.org/project/sphinx-lint/#history)
127126
128127
129128
## License

0 commit comments

Comments
 (0)