Migrated changelog to use towncrier #1481
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andy-maier
force-pushed
the
andy/towncrier
branch
2 times, most recently
from
e2b75f2
to
80b6033
Compare
andy-maier
changed the title
andy-maier
force-pushed
the
andy/towncrier
branch
3 times, most recently
from
4d64cdb
to
6053d6f
Compare
andy-maier
force-pushed
the
andy/towncrier
branch
11 times, most recently
from
a7a80f3
to
d53b7b0
Compare
andy-maier
force-pushed
the
andy/towncrier
branch
from
d53b7b0
to
00e1702
Compare
andy-maier
force-pushed
the
andy/towncrier
branch
2 times, most recently
from
5304e48
to
33ac84d
Compare
EdGue42
approved these changes
Jun 6, 2024
Details:
* Added installation of the 'towncrier' package to the development environment.
Since towncrier version 22.8.0 changed the passed variables for the title
line, we use that version as a minimum. That version requires Python>=3.7.
* Created a copy of the default.rst template of towncrier 22.8.0 and modified
it to be compatible with the format of our current change logs.
In addition, changed the following:
- Added support for suppressing the listing of any change fragment files
whose filename starts with 'noissue'.
- Added support for not showing any change fragment files with type
'notshown' (in case a change does not intend to have an associated change
log entry).
* Moved the change log entries since the version in development was started,
into change fragment files.
* Added a check to the test workflow that the change contains at least one
change to the 'changes' directory.
* Updated the development section of the documentation to add a section
'Making a change' which describes the use of towncrier.
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
andy-maier
force-pushed
the
andy/towncrier
branch
from
33ac84d
to
959d212
Compare
EdGue42
approved these changes
Jun 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
For details, see the commit message.
This is a first step for simplifying the procedures for releasing a version and starting a new version. For the complete proposal, see issue #1485