Skip to content

Commit

Permalink
Merge branch 'prepare-0-2-1-release'
Browse files Browse the repository at this point in the history
  • Loading branch information
jerith committed Sep 25, 2024
2 parents 74174b1 + 5f7e308 commit 25ae3f5
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
7 changes: 7 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Purpose
_Why does this exist?_

#### Checklist
- [ ] Added or updated unit tests
- [ ] Added to release notes
- [ ] Updated readme/documentation (if necessary)
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
### Added

### Fixed
- Correctly parse message timestamps with a trailing Z UTC indicator
- Decode potential delivery reports as latin1 to prevent encoding-related crashes (#71)
- Correctly parse message timestamps with a trailing Z UTC indicator (#74)

### Changed

Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,19 @@ If you're using an editor that supports [LSP](https://microsoft.github.io/langua
```

Configuring LSP depends on your editor. In most cases, the default configuration for the relevant plugin or extension should be suitable.

## Release process

To release a new version, follow these steps:

1. Make sure all relevant PRs are merged and that all necessary QA testing is complete
1. Make sure release notes are up to date and accurate
1. In one commit on the `main` branch:
- Update the version number in `pyproject.toml` to the release version
- Replace the UNRELEASED header in `CHANGELOG.md` with the release version and date
1. Tag the release commit with the release version (for example, `v0.2.1` for version `0.2.1`)
1. Push the release commit and tag
1. In one commit on the `main` branch:
- Update the version number in `pyproject.toml` to the next pre-release version
- Add a new UNRELEASED header in `CHANGELOG.md`
1. Push the post-release commit

0 comments on commit 25ae3f5

Please sign in to comment.