Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.23 KB

RELEASING.md

File metadata and controls

34 lines (25 loc) · 1.23 KB
Raw

Releasing a new version of Pygls

Pygls is hosted as a package at https://pypi.org/project/pygls

Releases follow https://keepachangelog.com/en/1.0.0 and https://semver.org/spec/v2.0.0.html

Release notes are kept in CHANGELOG.md

Steps to release

  • Install:
    • Python's build module with Pip or your OS's package manager
    • Twine for interacting with pypi.org
  • It's probably best to make a dedicated release branch, but not essential
  • Update CHANGELOG.md
  • Change version in pygls/init.py
  • Commit
# Python's `setuptools` automatically derives the version from the latest Git tag.
# NB. If the latest commit doesn't have a tag, then `setuptools` will add `dev-[hash]` to the version.
git tag v"$(python -c 'from pygls import __version__; print(__version__)')"
git push --tags # not required for releasing, just needed because normal `git push` won't send the tags

# Build the project into the Source and Wheel formats (they go into `./dist`)
rm -rf dist pygls.egg-info
python -m build

# Upload to Pypi
# You'll also need, or have access to, the Pygls Pypi org or account. Likely from @dgreisen
twine upload dist/*