From a75db39d117399a6c6f638a2d203968339ce1cd8 Mon Sep 17 00:00:00 2001 From: Jesse Claven Date: Thu, 22 Aug 2024 11:35:04 +0100 Subject: [PATCH] build: Add release process (#112) Thought I'd document this whilst I'm doing it. --- RELEASE.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..b8dbb25 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,13 @@ +# Release Process + +1. Bump the package version (example: [https://github.com/climatepolicyradar/azure-pdf-parser/pull/93](https://github.com/climatepolicyradar/azure-pdf-parser/pull/93)). +2. Compare the most recent release to `main` (example: [https://github.com/climatepolicyradar/azure-pdf-parser/compare/v0.4.1...main](https://github.com/climatepolicyradar/azure-pdf-parser/compare/v0.4.1...main)). You'll generally do a release at the `HEAD` of `main`, but, you can do a release at any point after the last release. +3. Tag the commit you want to do a release at (example: on `main`, do `git tag v0.4.2`). +4. Push the tag (example: `git push origin v0.4.2`). +5. Create a new release ([https://github.com/climatepolicyradar/azure-pdf-parser/releases/new](https://github.com/climatepolicyradar/azure-pdf-parser/releases/new)). +6. For "Choose a tag", select your new tag, and for "Previous tag", change it from "auto" to the last release (example: `v0.4.1`). +7. Press "Generate release notes" and verify that they're as expected. +8. Ensure "Set as the latest release" is selected. +9. Press "Publish release". + +NB: We follow SemVer.