From b9d7f5a013f0c6d9aed452b56ad74e860778b010 Mon Sep 17 00:00:00 2001 From: Jean-Marc Meessen Date: Tue, 11 Aug 2020 12:40:31 +0200 Subject: [PATCH] Add custom release notes --- .github/workflows/release.yml | 2 +- .goreleaser.yml | 8 ++++++++ doc/whats_new.md | 14 ++++++++++++++ todo.md | 10 +++++----- 4 files changed, 28 insertions(+), 6 deletions(-) create mode 100644 doc/whats_new.md diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 4ddb2ad..273cd08 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -19,6 +19,6 @@ jobs: - name: Release via goreleaser uses: goreleaser/goreleaser-action@master with: - args: release + args: release --release-notes=doc/whats_new.md env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.goreleaser.yml b/.goreleaser.yml index b84f3a5..0385b45 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -59,6 +59,14 @@ archives: format: zip files: - README.md + - doc/whats_new.md + - doc/usage.md + - doc/install.md + - doc/install_mac.md + - doc/pictures/Error_1.png + - doc/pictures/Error_2.png + - doc/pictures/security_setting.png + - doc/pictures/System_preference.png checksum: name_template: 'checksums.txt' diff --git a/doc/whats_new.md b/doc/whats_new.md new file mode 100644 index 0000000..697d84d --- /dev/null +++ b/doc/whats_new.md @@ -0,0 +1,14 @@ +# What's new? + +## V0.1.1 +* improved test coverage +* improved build automation +* improved release notes publication + +## Previous releases + +### V0.1.0 +* First public MVP (Minimal Viable Product relase). Supports only SOTA and WWFF type log files. Some header keywords are missing as well as date increments. + +### V0.0.0 +* Initial release diff --git a/todo.md b/todo.md index 863b39d..c8eb34f 100644 --- a/todo.md +++ b/todo.md @@ -8,9 +8,9 @@ * [-] Implement MacOS codesigning (issue #9) * [x] Add quality badges to main page * [x] Make a more reasonable/richer version display (issue #10) -* [ ] Create standalone documentation, separate from README (issue #13) -* [ ] Re-visit the release notes (far too verbose) -* [ ] Implement and track code coverage +* [x] Create standalone documentation, separate from README (issue #13) +* [x] Re-visit the release notes (far too verbose) +* [x] Implement and track code coverage @@ -21,7 +21,7 @@ * [ ] Support date not prefixed by "date" (non header mode) DATE keyword is now optional * [ ] Support date increment ("date +" and "date ++") * [ ] Support WWFF keyword -* [ ] Validate that we have the necessary data for the output +* [x] Validate that we have the necessary data for the output * [ ] Support the contest related fields ## Output processing @@ -32,5 +32,5 @@ * [ ] Process contest reports * [ ] Infer digital mode report * [ ] add unit test for the DefaultReport validate function -* [ ] look how to make it work as a CGI +* [-] look how to make it work as a CGI