Skip to content

Commit

Permalink
chore: properly indent RELEASING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tombh committed Aug 24, 2024
1 parent 68d6408 commit 9cf066a
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 9cf066a

Please sign in to comment.