Releases: rhysd/changelog-from-release
Releases · rhysd/changelog-from-release
v3.9.0
- Add
-c
option to generate "Contributors" section like below. Here is the example of actionlint repository enabling the option. There are some notes on this option. Please read the document for more details. (#33, thanks @yottahmd)## Contributors <a href="https://github.com/rhysd"><img src="https://wsrv.nl/?url=https%3A%2F%2Fgithub.com%2Frhysd.png&w=128&h=128&fit=cover&mask=circle" width="64" height="64" alt="@rhysd"></a> <a href="https://github.com/yottahmd"><img src="https://wsrv.nl/?url=https%3A%2F%2Fgithub.com%2Fyottahmd.png&w=128&h=128&fit=cover&mask=circle" width="64" height="64" alt="@yottahmd"></a>
- Fix crash when some external reference prefix contains a regex meta character.
v3.8.1
- Fix resolving redirect of repository URL does not work when the repository is hosted on a GitHub Enterprise server. changelog-from-release tries to resolve a repository URL because the repository may have been renamed. However GitHub Enterprise server redirects a repository URL to its login page when the request is not authenticated. Now changelog-from-release detects a login page URL and stops resolving the redirect.
v3.8.0
- Support more auto link references following the GitHub's official spec. Please read the 'Reference auto linking' section for more details. Some examples:
- Commit URL: 50b11ed, rhysd/actionlint@1ba25a7
- Issue/PR URL: #1, rhysd/actionlint#453
GH-
reference link: GH-1
- Support the custom autolinks. Please read the 'Custom autolink' section for more details.
- GitHub API requires "Administration" repository permissions (read). You need to set your personal access token to the
GITHUB_TOKEN
environment variable with proper permission.
- GitHub API requires "Administration" repository permissions (read). You need to set your personal access token to the
- Fix pre-releases are included in a generated changelog. (#31)
- Add
-p
flag to include pre-releases in a generated changelog. - Prefer the ISO-standard date format
YYYY-MM-DD
. (#27)- This follows the recommendation by keep a changelog.
- Previous format (e.g.
02 Jan 2006
) was not good because not all release notes are written in English.
- Use
id
attribute instead ofname
attribute for<a>
elements in a generated changelog because thename
attribute is deprecated. - Fix releases are not correctly filtered when both
-d
and-i
/-e
are specified. - Set 120 seconds timeout to GitHub API requests.
- Send requests to GitHub in parallel to fetch repository data faster.
- Add
-debug
flag and debug log. When something went wrong, enabling debug log helps to analyze what happened. - Include checksums for each released archives in the release assets as
changelog-from-release_{version}_checksums.txt
. - Require Go 1.22 or later for build.
- Update
go-github
dependency from v58 to v66.
v3.7.2
v3.7.1
- Ensure a trailing
/
in the API base URL set inGITHUB_API_BASE_URL
environment variable - Show a diff of updated changelog in action output instead of printing an entire changelog
- Update
google/go-github
from v40 to v45 - Improve help description of
-r
option
v3.7.0
- Add
-r
option to specify a remote URL of repository.# Generate changelog for rhysd/changelog-from-release changelog-from-release -r 'https://github.com/rhysd/changelog-from-release'
- Fix repeating Git tag name in a release heading when a release title already includes it (#20). For example, when a release title is
v1.2.3 with some features
and its Git tag isv1.2.3
, the generated heading is:- until v3.7.0:
v1.2.3 with some features (v1.2.3)
- from v3.7.0:
v1.2.3 with some features
- until v3.7.0:
- Ensure spaces are trimmed from release title and release name.
v3.6.1
- Fix 404 response is not handled when trying to resolve private renamed repositories. (#19)
- For private repositories, repository rename is not resolved because GitHub always returns 404 even if an authentication token is set. Please ensure the Git remote URL in your local repository is up-to-date when running
changelog-from-release
command in this case.
- For private repositories, repository rename is not resolved because GitHub always returns 404 even if an authentication token is set. Please ensure the Git remote URL in your local repository is up-to-date when running
v3.6.0
- If you enable protected-branch,
rhysd/changelog-from-release/action
action cannot push a commit directly to the branch. Instead, usepull_request
input to create a pull request to update the changelog. (#17)- uses: rhysd/changelog-from-release/action@v3 with: file: CHANGELOG.md github_token: ${{ secrets.GITHUB_TOKEN }} pull_request: true
v3.5.2
- Check and follow redirects for Git remote URLs. This check is necessary to resolve renamed old repositories correctly. (#16)
- Avoid unnecessary memory allocation when no reference link is included in changelog.
- Update dependencies to include
golang.org/x/*
packages which were newly managed as Go modules.
v3.5.1
- Add
-d
option to include/exclude drafts in generated changelog. (thanks @paescuj, #15)# Exclude drafts from the output changelog-from-release -d=false > CHANGELOG.md
- Include version of
changelog-from-release
in the footer of generated output - Remove a single space which were prepended to a footer line
- Do not fail when no release is found since an empty changelog is a good start point of development