fix: check for a changelog text before returning a changelog url #10522
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
zeroxdeadx
force-pushed
the
fix/wrong-changelog
branch
2 times, most recently
from
0a35f59
to
2af7e98
Compare
zeroxdeadx
force-pushed
the
fix/wrong-changelog
branch
from
2af7e98
to
be81249
Compare
zeroxdeadx
force-pushed
the
fix/wrong-changelog
branch
3 times, most recently
from
997359d
to
5e0e582
Compare
honeyankit
approved these changes
Sep 20, 2024
Currently, the changelog_url function (message_builder.rb) returns a url to the first changelog file with a name from the list defined in Dependabot::MetadataFinders::Base::ChangelogFinder::CHANGELOG_NAMES. This causes it to sometimes return a url to a file, which is definitely not a changelog (e.g. some script used to make a release of a library). The commit message ends up containing a url that shouldn't be there. The solution is to check the contents of the changelog file by invoking the changelog_text function (metadata_finders/base.rb) in an 'if' statement before returning the result of the changelog_url function. The same approach is used in the changelog_cascade function, which is used for building a pull request message (metadata_presenter.rb). Signed-off-by: zeroxdead <zeroxdead@proton.me>
amazimbe
force-pushed
the
fix/wrong-changelog
branch
from
5e0e582
to
2b19878
Compare
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.
What are you trying to accomplish?
I'm trying to fix a problem where dependabot creates a pull request, and its commit message contains a url to a file that is not a changelog. The pull request message, in its turn, doesn't contain that url.
Anything you want to highlight for special attention from reviewers?
Perhaps we could solve this issue by allowing a changelog file to have only the '.md' extension or no extension at all (like "changelog", "changelog.md", "history", "history.md" and so on). I haven't chosen this approach because (maybe) some projects use files with different extensions for their release notes.
How will you know you've accomplished your goal?
I've written a test to ensure the issue is fixed.
Checklist