Skip to content

Commit 75717ee

Browse files
committed
Add MAINTENANCE.md document
1 parent abd6dbb commit 75717ee

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

MAINTENANCE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
The following are instructions to maintain python-lsp-black
2+
1. Releases are tracked using Github milestones, which can be created and closed
3+
under the `Issues > Milestones` page: https://github.com/python-lsp/python-lsp-black/milestones.
4+
2. If a issue will be fixed as part of a particular release, then its milestone
5+
should be the release-corresponding one.
6+
3. Please make sure that PRs are also tracked under a specific milestone.
7+
4. Please follow the [RELEASE.md](./RELEASE.md) file when making a release.

RELEASE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ To release a new version of python-lsp-black:
22
1. git fetch upstream && git checkout upstream/master
33
2. Close milestone on GitHub
44
3. git clean -xfdi
5-
4. Update CHANGELOG.md with loghub
5+
4. Update CHANGELOG.md with loghub: `loghub python-lsp/python-lsp-black --milestone vX.X.X`
66
5. git add -A && git commit -m "Update Changelog"
7-
6. Update release version in ``setup.cfg`` (set release version, remove 'dev0')
7+
6. Update release version in ``setup.cfg`` (set release version, remove '.dev0')
88
7. git add -A && git commit -m "Release vX.X.X"
99
8. python setup.py sdist
1010
9. python setup.py bdist_wheel
11-
10. twine check
12-
11. twine upload
11+
10. twine check dist/*
12+
11. twine upload dist/*
1313
12. git tag -a vX.X.X -m "Release vX.X.X"
1414
13. Update development version in ``setup.cfg`` (add '.dev0' and increment minor)
1515
14. git add -A && git commit -m "Back to work"

0 commit comments

Comments
 (0)