fix(config): default to empty header and footer (#1161) #1172
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR removes the default values for
changelog.header
andchangelog.footer
in config/cliff.toml. This allows users to not have a header and/or footer if they so choose.Warning: Users that don't have headers and/or footers defined in their own config but want them will have to update their config after this change has been released. They should add the following settings to return to the previous behaviour:
Note: The fixtures use different methods of newline handling in their body templates. We should investigate means of standardizing this going forward.
Motivation and Context
The changes introduced in #1087 resulted in
changelog.header
andchangelog.footer
being set to predefined templates. This resulted in #1161.How Has This Been Tested?
Ran all fixtures.
Screenshots / Logs (if applicable)
Types of Changes
Checklist: