Release notes

This commit is contained in:
John Kerl 2022-11-27 13:29:49 -05:00
parent 24528e1f4a
commit 3333d16708
4 changed files with 18 additions and 8 deletions

View file

@ -37,10 +37,12 @@ In this example I am using version 6.2.0 to 6.3.0; of course that will change fo
* Create the Github release tag:
* Don't forget the `v` in `v6.3.0`
* Write the release notes
* Get binaries from latest successful build from [https://github.com/johnkerl/miller/actions](https://github.com/johnkerl/miller/actions), or, build them on buildboxes. Note that thanks to [PR 822](https://github.com/johnkerl/miller/pull/822) which introduces [goreleaser](https://github.com/johnkerl/miller/blob/main/.goreleaser.yml) there are versions for many platforms auto-built and auto-attached to the GitHub release (below). The only exception is for Windows: goreleaser makes a `.tar.gz` file but it's nice to attach a `.zip` from GitHub actions for the benefit of Windows users.
* Attach the release tarball, Windows `.zip`, and SRPM. Double-check assets were successfully uploaded.
* Publish the release in draft mode, until all CI jobs finish successfully. Note that gorelease will create and attach the rest of the binaries.
* Write the release notes -- save as a pre-release until below
* Be sure the commit being used is the (non-`main`) PR commit containing the new version, or, `main` after that PR is merged back to `main`. (Otherwise, the release will be tagging the commit _before_ the changes, and `mlr version` will not show the new release number.)
* Thanks to [PR 822](https://github.com/johnkerl/miller/pull/822) which introduces [goreleaser](https://github.com/johnkerl/miller/blob/main/.goreleaser.yml) there are versions for many platforms auto-built and auto-attached to the GitHub release.
* Attach the release tarball and SRPM. Double-check assets were successfully uploaded.
* Publish the release in pre-release mode, until all CI jobs finish successfully. Note that gorelease will create and attach the rest of the binaries.
* Before marking the release as public, download an executable from among the generated binaries and make sure its `mlr version` prints what you expect -- else, restart this process.
* Then mark the release as public.
* Check the release-specific docs:

View file

@ -21,10 +21,12 @@ In this example I am using version 6.2.0 to 6.3.0; of course that will change fo
* Create the Github release tag:
* Don't forget the `v` in `v6.3.0`
* Write the release notes
* Get binaries from latest successful build from [https://github.com/johnkerl/miller/actions](https://github.com/johnkerl/miller/actions), or, build them on buildboxes. Note that thanks to [PR 822](https://github.com/johnkerl/miller/pull/822) which introduces [goreleaser](https://github.com/johnkerl/miller/blob/main/.goreleaser.yml) there are versions for many platforms auto-built and auto-attached to the GitHub release (below). The only exception is for Windows: goreleaser makes a `.tar.gz` file but it's nice to attach a `.zip` from GitHub actions for the benefit of Windows users.
* Attach the release tarball, Windows `.zip`, and SRPM. Double-check assets were successfully uploaded.
* Publish the release in draft mode, until all CI jobs finish successfully. Note that gorelease will create and attach the rest of the binaries.
* Write the release notes -- save as a pre-release until below
* Be sure the commit being used is the (non-`main`) PR commit containing the new version, or, `main` after that PR is merged back to `main`. (Otherwise, the release will be tagging the commit _before_ the changes, and `mlr version` will not show the new release number.)
* Thanks to [PR 822](https://github.com/johnkerl/miller/pull/822) which introduces [goreleaser](https://github.com/johnkerl/miller/blob/main/.goreleaser.yml) there are versions for many platforms auto-built and auto-attached to the GitHub release.
* Attach the release tarball and SRPM. Double-check assets were successfully uploaded.
* Publish the release in pre-release mode, until all CI jobs finish successfully. Note that gorelease will create and attach the rest of the binaries.
* Before marking the release as public, download an executable from among the generated binaries and make sure its `mlr version` prints what you expect -- else, restart this process.
* Then mark the release as public.
* Check the release-specific docs:

View file

@ -23,10 +23,13 @@ If your `mlr version` says something like `Miller v5.10.2` or `mlr 6.0.0`, witho
| Release | Docs | Release notes |
|---------|---------------------------------------------------------------------|---------------|
6.5.0 | [Miller 6.5.0](https://johnkerl.org/miller-docs-by-release/6.5.0) | [Bugfixes and memory-reduction optimizations](https://github.com/johnkerl/miller/releases/tag/v6.5.0) |
6.4.0 | [Miller 6.4.0](https://johnkerl.org/miller-docs-by-release/6.4.0) | [ mlr summary verb, exec() function, mlr cat --filename, multiline string literals, and more](https://github.com/johnkerl/miller/releases/tag/v6.4.0) |
6.3.0 | [Miller 6.3.0](https://johnkerl.org/miller-docs-by-release/6.3.0) | [Windows terminal colors, Latin-1, and more](https://github.com/johnkerl/miller/releases/tag/v6.3.0) |
6.2.0 | [Miller 6.2.0](https://johnkerl.org/miller-docs-by-release/6.2.0) | [Restore --tsvlite; add gssub and expand dhms functions](https://github.com/johnkerl/miller/releases/tag/v6.2.0) |
6.1.0 | [Miller 6.1.0](https://johnkerl.org/miller-docs-by-release/6.1.0) | [Natural sort, true TSV, sliding-window averages, and more](https://github.com/johnkerl/miller/releases/tag/v6.1.0) |
6.0.0 | [Miller 6.0.0](https://johnkerl.org/miller-docs-by-release/6.0.0) | [Miller 6](https://github.com/johnkerl/miller/releases/tag/v6.0.0) |
5.10.4 | [Miller 5.10.4](https://johnkerl.org/miller-docs-by-release/5.10.4) | [5.10 bugfix for issue #1108](https://github.com/johnkerl/miller/releases/tag/v5.10.4) |
5.10.3 | [Miller 5.10.3](https://johnkerl.org/miller-docs-by-release/5.10.3) | [Address Conda-build issue](https://github.com/johnkerl/miller/releases/tag/v5.10.3) |
5.10.2 | [Miller 5.10.2](https://johnkerl.org/miller-docs-by-release/5.10.2) | [Restore mlr manpage to distro file](https://github.com/johnkerl/miller/releases/tag/v5.10.2) |
5.10.1 | | [Bugfixes](https://github.com/johnkerl/miller/releases/tag/v5.10.1) |

View file

@ -7,10 +7,13 @@ If your `mlr version` says something like `Miller v5.10.2` or `mlr 6.0.0`, witho
| Release | Docs | Release notes |
|---------|---------------------------------------------------------------------|---------------|
6.5.0 | [Miller 6.5.0](https://johnkerl.org/miller-docs-by-release/6.5.0) | [Bugfixes and memory-reduction optimizations](https://github.com/johnkerl/miller/releases/tag/v6.5.0) |
6.4.0 | [Miller 6.4.0](https://johnkerl.org/miller-docs-by-release/6.4.0) | [ mlr summary verb, exec() function, mlr cat --filename, multiline string literals, and more](https://github.com/johnkerl/miller/releases/tag/v6.4.0) |
6.3.0 | [Miller 6.3.0](https://johnkerl.org/miller-docs-by-release/6.3.0) | [Windows terminal colors, Latin-1, and more](https://github.com/johnkerl/miller/releases/tag/v6.3.0) |
6.2.0 | [Miller 6.2.0](https://johnkerl.org/miller-docs-by-release/6.2.0) | [Restore --tsvlite; add gssub and expand dhms functions](https://github.com/johnkerl/miller/releases/tag/v6.2.0) |
6.1.0 | [Miller 6.1.0](https://johnkerl.org/miller-docs-by-release/6.1.0) | [Natural sort, true TSV, sliding-window averages, and more](https://github.com/johnkerl/miller/releases/tag/v6.1.0) |
6.0.0 | [Miller 6.0.0](https://johnkerl.org/miller-docs-by-release/6.0.0) | [Miller 6](https://github.com/johnkerl/miller/releases/tag/v6.0.0) |
5.10.4 | [Miller 5.10.4](https://johnkerl.org/miller-docs-by-release/5.10.4) | [5.10 bugfix for issue #1108](https://github.com/johnkerl/miller/releases/tag/v5.10.4) |
5.10.3 | [Miller 5.10.3](https://johnkerl.org/miller-docs-by-release/5.10.3) | [Address Conda-build issue](https://github.com/johnkerl/miller/releases/tag/v5.10.3) |
5.10.2 | [Miller 5.10.2](https://johnkerl.org/miller-docs-by-release/5.10.2) | [Restore mlr manpage to distro file](https://github.com/johnkerl/miller/releases/tag/v5.10.2) |
5.10.1 | | [Bugfixes](https://github.com/johnkerl/miller/releases/tag/v5.10.1) |