saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add note about package requirement files and changelog

Browse source
This commit is contained in:
Megan Wilhite 2022-11-03 14:16:59 -06:00
parent 5e834bbdf0
commit dd8a84e406
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/topics/development/changelog.rst
View file

@ -54,6 +54,15 @@ For a security fix your filename would look like this: changelog/cve-2021-25283.
If your PR does not align with any of the types, then you do not need to add a
changelog entry.
.. note::
Requirement Files:
Updates to package requirements files also require a changelog file. This will usually
be associated with `.fixed` if its resolving an issue or `.security` if it's resolving
a CVE issue in an upstream project. If updates are made to testing requirement files
it does not require a changelog.
.. _generate-changelog:
How to generate the changelog