feat: pre-release seperated changelog #454
Closed
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
Adds 2 parameters :
--separate-pre-changelog
: use a separate changelog for each type of pre-release--separate-pre-releases
: changes in the changelog will always relate to the latest release of the same pre-release type(and their respective implementation)
Checklist
./script/format
and./script/test
locally to ensure this change passes linter check and testExpected behavior
When
--separate-pre-releases
is used entries (features and fixes) should appear in a release even if they technicaly belong to a pre releaseWhen
--separate-pre-changelog
is used a changelog for each pre-release type should exist and be maintained by cz.Steps to Test This Pull Request
(
cz
being my modified version)Expected:
The CHANGELOG.md should look like this:
Additional context
This issue is kind of a draft, as i found no guidance of how to contribute.
While the PR template tells me what to do i do now know how. I cannot execute the above testcases as when i run
python3 __main__.py
the imports use my local installation of comittizen (usingvenv
and also not using venv) instead of my modified code. I also do not rly know what how to write or execute test cases. do i need to remove my local installation and do something like pip install my repo?I would love to contribute hight quality (well tested and documented etc) but as there is no documentation of how to contribute, I am a little stuck. (i followed the instructions in
docs/contributing.md
)If you would be so kind to provide some basic information and feedback i would check all the requirements.
(Some of this issues might be related to my very little development experience in python as i never dealt with package management etc. but I think a person should be able to contribute without greater knowledge about the eco-system)
Adresses issues