obsidian-export/docs/Release-checklist.md
Nick Groenen 638e83e9dc
Simplify and improve documentation
This removes mdBook in favor of a flat docs folder generating a single
`README.md` in the repository root.

Installation and usage instructions have also been expanded slightly.
2021-04-11 15:39:54 +02:00

15 lines
580 B
Markdown

# Release process
- [ ] Update version number in `Cargo.toml`
- [ ] Run `cargo check`
- [ ] Commit changes to `Cargo.*` with the message format `Release vN.N.N`
- [ ] Make git tag `vN.N.N`
- [ ] Run `gitchangelog`
- [ ] Regenerate README: `docs/generate.sh`
- [ ] Stage `CHANGES.md` and `docs/` and amend previous commit
- [ ] Force update git tag `vN.N.N`
- [ ] Push changes & tag
- [ ] Wait for builds to turn green (<https://github.com/zoni/obsidian-export/actions>)
- [ ] Run `cargo publish`
- [ ] Publish drafted release (<https://github.com/zoni/obsidian-export/releases>)