Skip to content

Commit 3ce422c

Browse files
committed
Update README and add release instructions
1 parent f3983c2 commit 3ce422c

File tree

2 files changed

+24
-7
lines changed

2 files changed

+24
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# pyls-black
1+
# python-lsp-black
2+
3+
[![PyPI](https://img.shields.io/pypi/v/pyls-black.svg)](https://pypi.org/project/python-lsp-black) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
4+
[![Python](https://github.com/python-lsp/python-lsp-black/actions/workflows/python.yml/badge.svg)](https://github.com/python-lsp/python-lsp-black/actions/workflows/python.yml)
25

3-
[![PyPI](https://img.shields.io/pypi/v/pyls-black.svg)](https://pypi.org/project/pyls-black/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
46

57
> [Black](https://github.com/ambv/black) plugin for the [Python LSP Server](https://github.com/python-lsp/python-lsp-server).
68
79
In the same `virtualenv` as `python-lsp-server`:
810

911
```shell
10-
pip3 install pyls-black
12+
pip install python-lsp-black
1113
```
1214

1315
To avoid unexpected results you should make sure `yapf` and `autopep8` are not installed.
1416

15-
* `pyls-black` can either format an entire file or just the selected text.
17+
* `python-lsp-black` can either format an entire file or just the selected text.
1618
* The code will only be formatted if it is syntactically valid Python.
1719
* Text selections are treated as if they were a separate Python file.
1820
Unfortunately this means you can't format an indented block of code.
19-
* `pyls-black` will use your project's [pyproject.toml](https://github.com/ambv/black#pyprojecttoml) if it has one.
20-
21-
See the [wiki](https://github.com/rupert/pyls-black/wiki) for instructions on how to use `pyls-black` with popular text editors.
21+
* `python-lsp-black` will use your project's [pyproject.toml](https://github.com/ambv/black#pyprojecttoml) if it has one.

RELEASE.md

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

0 commit comments

Comments
 (0)