Changelog support by default #45
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
…GitHub workflow is triggered. Add-on SHA256 sum will always be printed at the end of the file
josephsl
approved these changes
Oct 15, 2024
|
By the way, please resolve conflicts so merging can e done smoothly. |
|
@josephsl ready to merge. There are also other prs from Dependabot awaiting for review. Regarding documentation, you write much better than me, but if you don't have time enough, I may update it in another pull request. |
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.
Include a changelog file which will be part of the release body when GitHub workflow is triggered. Add-on SHA256 sum will always be printed at the end of the file.
Currently, most add-on developers don't explain what has changed between releases. A few of them edit the release to add a description, but it's too late to receive that description as part of the release notification. Others prefer automatic release notes, which point to a comparison page with a list of commits.
This pr adds the ability to summarise add-on changes in a file using Markdown, commit that file and have a changelog by default as part of the release body, saving extra time for developers.