Ensure At Least One Blank Line Between Old and New Changelog Content #511
Conversation
This file contains hidden or 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
Upgrade self-test hook from v1.23.0 to v2.24.0. The former version crashes with the following error: ImportError: cannot import name 'soft_unicode' from 'markupsafe' Configure Commitizen to automatically bump the version of its own hook that it uses. Use the new location of the repository in the commitizen-tools org.
The existing regex had numerous bugs and boiled down to a very complex way of matching any file whatsoever in the tests directory. Correct the syntax issues, and make a best guess at the original intent.
Replace "script" with the current name of the directory, "scripts."
The original explanation has some minor grammatical errors.
- Specify what output_lines and lines are lists of, namely strings. - Remove unnecessary test of whether latest_version_position is an int since x != None for any integer x. - Replace two consecutive list.append calls with a single list.extend call.
Ensure there is at least one blank line separating old and new content. We already separate the log entries for each release with blank lines, so separate pre-existing content from the first release with a blank line as well. If the pre-existing content ends in a blank line, then don't add an extra one.
Codecov Report
@@ Coverage Diff @@
## master #511 +/- ##
==========================================
+ Coverage 97.85% 97.92% +0.06%
==========================================
Files 39 39
Lines 1539 1540 +1
==========================================
+ Hits 1506 1508 +2
+ Misses 33 32 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Lee-W
reviewed
May 11, 2022
| @@ -3,7 +3,8 @@ version = "2.24.0" | |||
| tag_format = "v$version" | |||
| version_files = [ | |||
| "pyproject.toml:version", | |||
| "commitizen/__version__.py" | |||
| "commitizen/__version__.py", | |||
| ".pre-commit-config.yaml:rev.\\s+(?=[^\\n]+Commitizen)" | |||
| @@ -270,16 +270,14 @@ def incremental_build(new_content: str, lines: List, metadata: Dict) -> List: | |||
| if skip: | |||
| continue | |||
|
|
|||
| if ( | |||
| isinstance(latest_version_position, int) | |||
There was a problem hiding this comment.
Wondering why this condition is removed
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.
Description
Ensure there is at least one blank line separating old and new content when appending incrementally to the changelog. Log entries for each release are already separated with blank lines, so separate pre-existing content from the first release with a blank line as well. If the pre-existing content ends with a blank line, then don't add an extra one.
I also fixed some unrelated pre-existing issues with
.pre-commit-config.yamlin order to be able to comply with the contributing guidelines.Please let me know which documentation I should update if you feel this change warrants mention. I wasn't sure whether to classify this as a tiny feature or a bug fix.
Closes #509.
Checklist
./scripts/formatand./scripts/testlocally to ensure this change passes linter check and testExpected behavior
If the changelog already says "This changelog is auto-generated by the Python-based
Commitizen.", then when the first release is added by Commitizen, it doesn't ram right up against the pre-existing content.
Steps to Test This Pull Request
CHANGELOG.md, and add some content to it that doesn't end in an extra blank line (besides the one at the end of the file).cz changelog --incremental.