Invoke the changelog generator as part of the release

fluxcd · Nov 22, 2019 · b5fb99a · b5fb99a
1 parent 52d6b65
commit b5fb99a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/internal_docs/releasing.md b/internal_docs/releasing.md
@@ -51,6 +51,11 @@ The CircleCI script runs builds for tags, which push Docker images and upload bi
     For the Flux daemon, it's `CHANGELOG.md`; for the Helm operator, it's `CHANGELOG-helmop.md`. Follow the format established, and commit your
 change.
 
+    Use `go run internal_docs/generate_changelog_entry/main.go` to generate
+    an initial version of the entry. Then you should refine it and edit it
+    (i.e. adding a description the release, coalescing pull requests, adding
+    pull requests in the right sections ... ).
+
     If you cherry-picked commits, remember to only mention those changes.
 
     To compile a list of people (GitHub usernames) to thank, you can use a script (if you have access to weaveworks/dx) or peruse the commits/PRs merged/issues since the last release. There's no exact way to do it. Be generous.