obsidian-export/docs/Release-checklist.md

# Release process

- [ ] Run `just make-new-release`
- [ ] Push the created release commit/tag to GitHub
- [ ] Wait for builds to turn green (<https://github.com/zoni/obsidian-export/actions>) and confirm everything looks OK.
Add release checklist 2020-12-22 14:56:03 +03:00			`# Release process`

Change release process to use towncrier and delay regenerating README 1. Use [towncrier][1] to generate release notes/CHANGELOG instead of auto-generating it from git commit messages. 2. Move release scripts into a Justfile. 3. Only regenerate the top-level README file when making a release, don't force it to be up to date in between releases. Point 3 helps prevent documentation for unreleased changes from being shown to users on GitHub, which may otherwise be confusing. [1]: https://towncrier.readthedocs.io/en/stable/index.html# 2024-08-04 13:36:11 +03:00			- [ ] Run `just make-new-release`
Simplify releases with a script 2021-09-24 12:58:27 +03:00			`- [ ] Push the created release commit/tag to GitHub`
Use cargo-dist to create release artifacts This will create binaries for more platforms (including ARM builds for MacOS) and installer scripts in addition to just the binaries themselves. 2023-12-03 16:06:02 +03:00			`- [ ] Wait for builds to turn green (<https://github.com/zoni/obsidian-export/actions>) and confirm everything looks OK.`