Skip to content

Commit

Permalink
Add changelog command to docs
Browse files Browse the repository at this point in the history
Human-readable code changes included in each release are often kept in a
"changelog," which is a text file named CHANGELOG.

Manually-generated changelogs often have errors and omissions. On the
other hand, auto-generated changelogs often require extra dependencies,
do not include commit-level info, and do not annotate Git tags.

This project does not currently provide a CHANGELOG.md, but does provide
annotated and signed Git tags with informative tag messages. These tags
can be used to auto-generate a changelog.

This commit will add a changelog command to the contributing docs.
  • Loading branch information
br3ndonland committed Jul 30, 2022
1 parent dcfa947 commit 8c474b6
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,3 +266,18 @@ Change the port numbers to run multiple containers simultaneously (`-p 81:80`).
- Omit the leading `v` (use `1.0.0` instead of `v1.0.0`)
- Example: `git tag -a -s 1.0.0`
- Push the tag. GitHub Actions will build and push the Python package and Docker images.
- **To create a changelog:**

```sh
printf '# Changelog\n\n' >CHANGELOG.md

GIT_LOG_FORMAT='## %(subject) - %(taggerdate:short)
%(contents:body)
Tagger: %(taggername) %(taggeremail)
Date: %(taggerdate:iso)
%(contents:signature)'

git tag -l --sort=-taggerdate:iso --format="$GIT_LOG_FORMAT" >>CHANGELOG.md
```

0 comments on commit 8c474b6

Please sign in to comment.