Skip to content

Commit

Permalink
Add clarification on how to build changelog to documenting/changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
lkubb committed Aug 26, 2024
1 parent cf29c25 commit 77af26b
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/topics/documenting/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ Your Saltext project includes scaffolding for keeping a changelog via [towncrier

This changelog is rendered as part of the documentation.

:::{hint}
If you selected {question}`deploy_docs` == `rolling`, this changelog contains
upcoming changes from the `main` branch on top of the crystallized changes
from previous releases.
upcoming changes from the `main` branch on top of the [crystallized changes
from previous releases](changelog-build-target).
:::

(news-fragment-target)=
## Procedure
Expand Down Expand Up @@ -35,3 +37,6 @@ echo "Fixed a crash when 'foo.bar' is missing from the configuration" > changelo
```

This file should be submitted as part of the PR.

## Building the changelog
Before tagging a release, the individual `changelog/*.md` pieces need to be turned into the actual changelog. Please see [Building the changelog](changelog-build-target) for how to do this.

0 comments on commit 77af26b

Please sign in to comment.