Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update release instructions in README.md #89

Merged
merged 4 commits into from
Oct 13, 2023
Merged

Update release instructions in README.md #89

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8606880
Update release instructions in README.md
ezio-melotti Oct 13, 2023
13de0aa
Update history link.
ezio-melotti Oct 13, 2023
aa9cc48
Add quotes around our friends projects
ezio-melotti Oct 13, 2023
db5ba70
Fix wrong sentence.
ezio-melotti Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,22 +77,21 @@ $ docutils --writer=pseudoxml tests/fixtures/xpass/role-in-code-sample.rst

## Releasing

First test with friends projects by running:

sh download-more-tests.sh
python -m pytest

Bump the version in `sphinxlint.py`, commit, tag, push:

git tag v0.6.5
git push
git push --tags

To release on PyPI run:

python -m pip install --upgrade build twine
python -m build
python -m twine upload dist/*
1. Make sure that the [CI tests pass](https://github.com/sphinx-contrib/sphinx-lint/actions)
and optionally double-check locally with "friends projects" by running:

sh download-more-tests.sh
python -m pytest
2. Go on the [Releases page](https://github.com/sphinx-contrib/sphinx-lint/releases)
3. Click "Draft a new release"
4. Click "Choose a tag"
5. Type the next vX.Y.Z version and select "Create new tag: vX.Y.Z on publish"
6. Leave the "Release title" blank (it will be autofilled)
7. Click "Generate release notes" and amend as required
8. Click "Publish release"
9. Check the tagged
[GitHub Actions build](https://github.com/sphinx-contrib/sphinx-lint/actions/workflows/deploy.yml)
has [deployed to PyPI](https://pypi.org/project/sphinx-lint/#history)


## License
Expand Down