Added format detector #11
Merged
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
rimi-itk
force-pushed
the
feature/changelog-format-detection
branch
from
a540259 to
c8abfdb
Compare
jeppekroghitk
approved these changes
Nov 7, 2024
changelog/format_detector.go
Outdated
| } | ||
|
|
||
| if len(templates) < 1 { | ||
| return "", fmt.Errorf("cannot detect pull request entry format") |
There was a problem hiding this comment.
I think providing an entry with a fallback template is the better option here. Even if it doesn't match the changelog entry format, it would still be faster for the user to edit the format than to enter it manually.
There was a problem hiding this comment.
I agree! I had the same thought, but couldn't make my mind up on how to handle this.
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.
We don't use the same pull request entry format in our changelogs across projects. This adds a “changelog format detector” that can help detect the format used in a project. Currently, three formats observed in the wild are supported:
Exhibit 1 (e.g. https://github.com/itk-dev/ai-screening/blob/develop/CHANGELOG.md):
Exhibit 2 (e.g. https://github.com/itk-dev/devops_itksites/blob/develop/CHANGELOG.md):
Exhibit 3 (e.g. https://github.com/itk-dev/hoeringsportal/blob/develop/CHANGELOG.md):