diff --git a/RELEASING.md b/RELEASING.md index 7df3faa3..17c1b5fd 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -2,21 +2,21 @@ 1. Update the version number in `pyproject.toml` -- Try to follow https://semver.org/ -- Commit message title should be something like: `build: v1.3.0` -- Typically you'll want to make a dedicated PR for the version bump. But if a previous PR has already merged the wanted version bump into main, then a new PR is not necessary. -- Example PR for a release https://github.com/openlawlibrary/pygls/pull/434 -- Merge the PR + - Try to follow https://semver.org/ + - Commit message title should be something like: `build: v1.3.0` + - Typically you'll want to make a dedicated PR for the version bump. But if a previous PR has already merged the wanted version bump into main, then a new PR is not necessary. + - Example PR for a release https://github.com/openlawlibrary/pygls/pull/434 + - Merge the PR 2. Create a Github Release -- Goto https://github.com/openlawlibrary/pygls/releases/new -- In the "Choose a tag" dropdown button, type the new version number. -- Click the "Generate release notes" button. -- Generating release notes does not require making an actual release, so you may like to copy and paste the output of the release notes to make the above release PR more informative. -- If it's a pre-release, remember to check the "Set as a pre-release" toggle. -- Click the green "Publish release button". -- Once the Github Release Action is complete (see https://github.com/openlawlibrary/pygls/actions), check https://pypi.org/project/pygls/ to verify that the new release is available. + - Goto https://github.com/openlawlibrary/pygls/releases/new + - In the "Choose a tag" dropdown button, type the new version number. + - Click the "Generate release notes" button. + - Generating release notes does not require making an actual release, so you may like to copy and paste the output of the release notes to make the above release PR more informative. + - If it's a pre-release, remember to check the "Set as a pre-release" toggle. + - Click the green "Publish release button". + - Once the Github Release Action is complete (see https://github.com/openlawlibrary/pygls/actions), check https://pypi.org/project/pygls/ to verify that the new release is available. ## Notes