Commit Graph

16 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
7bbd211732
Remove leftover --ignore-frontmatter-keyword docs reference
An earlier iteration of #163 included this flag, but the final version
only uses `--skip-tags` and `--only-tags`.
2023-12-03 17:21:44 +01:00
Nick Groenen
d6f8b4e692
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 17:06:31 +01:00
Martin Heuschober
018c9606a6
Implement frontmatter based filtering (#163)
This allows limiting the notes that will be exported using `--skip-tags` and `--only-tags`

---------

Co-authored-by: Martin Heuschober <martin.heuschober@posteo.net>
Co-authored-by: Nick Groenen <nick@groenen.me>
Co-authored-by: Martin Heuschober <martin_heuschober@trimble.com>
2023-12-02 11:29:29 +01:00
Nick Groenen
4c74371b9e
Use /bin/bash when generating README
set -o pipefail is a bashism that not all shells support. Notably, this
fails with the default /bin/sh on GitHub Actions Linux runners
2023-09-26 09:08:56 +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
Robert Sesek
43d90d7879 Rename docs/contibuting.md to docs/contribute.md
On case-insensitive filesystems, the part file conflicts with the
docs/CONTRIBUTING.md symlink.
2023-09-26 08:42:16 +02:00
Nick Groenen
b38e4d53b5
Remove changelog from main README file 2023-09-24 12:14:47 +02:00
Nick Groenen
b28e4913ee
Relicense to BSD-2-Clause Plus Patent License
This license achieves everything that dual-licensing under MIT + Apache
aims for, but without the weirdness of being under two licenses.

Having checked external contributions, I feel pretty confident that I
can unilaterally make this license change, as people have only
contributed a handful of one-line changes of no significance towards
copyrighted work up to this point.
2023-09-24 12:05:15 +02:00
Nick Groenen
586530cac8 Add a contributor guide 2022-11-05 14:15:18 +01:00
Nick Groenen
f70d6b0cf0
Simplify releases with a script 2021-09-24 12:01:37 +02:00
Nick Groenen
634b0d70ac
New: add start_at option to export a partial vault
This introduces a new `--start-at` CLI argument and corresponding
`start_at()` method on the Exporter type that allows exporting of only a
given subdirectory within a vault.

See the updated README file for more details on when and how this may be
used.
2021-08-27 16:03:54 +02:00
Nick Groenen
5e8e8b9c96
Update release checklist 2021-04-11 16:33:03 +02:00
Nick Groenen
84a9abc98d
Add extra license disclaimer 2021-04-11 16:27:07 +02:00
Nick Groenen
50e9a3a3a3
Document workaround for relative links issue with Hugo 2021-04-11 16:22:35 +02: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