Commit Graph

9 Commits

Author SHA1 Message Date
Nick Groenen
72735cfff8
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 14:19:50 +02:00
Nick Groenen
da9238a78c
Use nightly rust for formatting to group import statements 2024-08-03 14:39:07 +02:00
Nick Groenen
bd1220028b
Run clippy and tests with --all-targets --all-features 2024-08-03 13:17:45 +02:00
Nick Groenen
3d98d65403
Add additional common pre-commit-hooks
I have these hooks enabled on many of my projects, but for some reason
forgot them here which led to the issue described in
https://github.com/zoni/obsidian-export/pull/181

This should help prevent that from happening again.
2023-09-26 08:48:06 +02:00
Nick Groenen
081eb6c9ab
Simplify pre-commit setup
No need to depend on a third-party hook repository when each of these
checks is easily defined and run through system commands.

This also allows us to actually run tests, which is current unsupported
(https://github.com/doublify/pre-commit-rust/pull/19)
2022-01-16 17:06:52 +01:00
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
Nick Groenen
466bc28485
Run mdbook hook against README.md too 2020-12-08 01:03:24 +01:00
Nick Groenen
6de76d9480
Add MdBook generation script and precommit hook 2020-12-08 01:00:09 +01:00
Nick Groenen
c2de776148
Public release 2020-12-07 22:35:57 +01:00