Link to license and changelog in overview #564
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
cuihtlauac
changed the title
cuihtlauac
changed the title
tmattio
reviewed
Sep 7, 2022
There was a problem hiding this comment.
Thanks a lot for the PR @cuihtlauac!
The approach looks great overall, I left a few comments with suggestions.
Fix #36 Display links to change log, readme, license in overview. Also displays licence name.
Skip changelog section if CHANGES.md file is missing
Some packages store their changelog in a file named CHANGES instead of CHANGES.md. This allows to handle both cases.
Both changelog and license file name candidates are searched: * as plain text file (i.e. without extension) * as markdown file (i.e. with .md extension). Searched base name candidates are: * License: LICENSE * Changelog: CHANGES and CHANGELOG In case other base names are missing, just add them to the list. If either changelog or license is missing, no link will be inserted in the overview.
|
Thanks @cuihtlauac! I took the liberty to push 67eb6e9 with some cosmetic changes, essentially to rename the |
|
Excellent, maybe_files is indeed much better your way, many thanks. Let's go for this |
Closed
sabine
pushed a commit
that referenced
this pull request
Oct 21, 2022
Display links to change log, readme, license in package overview. Also displays licence name. Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com> Co-authored-by: Thibaut Mattio <thibaut.mattio@gmail.com>
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.
Fix #36
Display links to changelog and license in overview, if available.