v3.8.0

• Support more auto link references following the GitHub's official spec. Please read the 'Reference auto linking' section for more details.
  • 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.
• 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 of name attribute for <a> elements in a generated changelog because the name 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

• Fix getting a tag from $GITHUB_EVENT_PATH environment variable in action (#23, thanks @linde12)
• Fix only github.com is allowed as host name for GHE environment
• Do not download files on Git LFS when updating changelog file in action (#24)
• Update Go module dependencies including go-github v58

v3.7.1

• Ensure a trailing / in the API base URL set in GITHUB_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 is v1.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
• 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.

v3.6.0

• If you enable protected-branch, rhysd/changelog-from-release/action action cannot push a commit directly to the branch. Instead, use pull_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

v3.4.0

• Add -i option to ignore release tags by regular expression pattern. For example, if your project has nightly tag release for nightly builds, it can be excluded as follows:

  changelog-from-release -i '^nightly$' > CHANGELOG.md

• Add -e option to extract release tags by regular expression pattern. For example, if your project uses v{major}.{minor}.{patch} format for release tags, they can be extracted as follows:

  changelog-from-release -e '^v\d+\.\d+\.\d+$' > CHANGELOG.md

• Allow multiple drafts in releases. For including draft releases, see the FAQ for more details.

v3.3.0

• Add args input to the action to define command line arguments passed to changelog-from-release command.

  - uses: rhysd/changelog-from-release/action@v3
    with:
      file: CHANGELOG.md
      github_token: ${{ secrets.GITHUB_TOKEN }}
      # Pass `-l 2` to use `##` instead of `#` for each release section
      args: -l 2

• Add header and footer inputs to the action to insert templates before/after the generated changelog. The following step inserts the header and the footer.

  - uses: rhysd/changelog-from-release/action@v3
    with:
      file: CHANGELOG.md
      github_token: ${{ secrets.GITHUB_TOKEN }}
      args: -l 2
      header: |
        Changelog
        =========
  
        This is header.
      footer: |-
  
        This is footer.

• Report an error when the release is not associated with any Git tags. This can happen when the release is a draft.
• Fix release date is broken when the release is a draft. Instead of published date, created date is used in the case.
• Add FAQ section to readme document. Currently two topics are described.
  • How to update changelog before adding the release tag?
  • How to insert some templates at top/bottom of generated changelog?