diff --git a/CHANGELOG.md b/CHANGELOG.md index da1baa7..a9d14fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ - + # [v3.7.2](https://github.com/rhysd/changelog-from-release/releases/tag/v3.7.2) - 2024-01-26 - Fix getting a tag from `$GITHUB_EVENT_PATH` environment variable in action ([#23](https://github.com/rhysd/changelog-from-release/issues/23), thanks [@linde12](https://github.com/linde12)) @@ -9,7 +9,7 @@ [Changes][v3.7.2] - + # [v3.7.1](https://github.com/rhysd/changelog-from-release/releases/tag/v3.7.1) - 2023-04-12 - Ensure a trailing `/` in the API base URL set in `GITHUB_API_BASE_URL` environment variable @@ -20,7 +20,7 @@ [Changes][v3.7.1] - + # [v3.7.0](https://github.com/rhysd/changelog-from-release/releases/tag/v3.7.0) - 2023-01-29 - Add `-r` option to specify a remote URL of repository. @@ -36,7 +36,7 @@ [Changes][v3.7.0] - + # [v3.6.1](https://github.com/rhysd/changelog-from-release/releases/tag/v3.6.1) - 2023-01-16 - Fix 404 response is not handled when trying to resolve private renamed repositories. ([#19](https://github.com/rhysd/changelog-from-release/issues/19)) @@ -45,7 +45,7 @@ [Changes][v3.6.1] - + # [v3.6.0](https://github.com/rhysd/changelog-from-release/releases/tag/v3.6.0) - 2023-01-13 - If you enable [protected-branch](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches), `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](https://github.com/rhysd/changelog-from-release/issues/17)) @@ -60,7 +60,7 @@ [Changes][v3.6.0] - + # [v3.5.2](https://github.com/rhysd/changelog-from-release/releases/tag/v3.5.2) - 2023-01-05 - Check and follow redirects for Git remote URLs. This check is necessary to resolve renamed old repositories correctly. ([#16](https://github.com/rhysd/changelog-from-release/issues/16)) @@ -70,7 +70,7 @@ [Changes][v3.5.2] - + # [v3.5.1](https://github.com/rhysd/changelog-from-release/releases/tag/v3.5.1) - 2022-12-12 - Add `-d` option to include/exclude drafts in generated changelog. (thanks [@paescuj](https://github.com/paescuj), [#15](https://github.com/rhysd/changelog-from-release/issues/15)) @@ -85,7 +85,7 @@ [Changes][v3.5.1] - + # [v3.4.0](https://github.com/rhysd/changelog-from-release/releases/tag/v3.4.0) - 2022-08-27 - 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: @@ -101,7 +101,7 @@ [Changes][v3.4.0] - + # [v3.3.0](https://github.com/rhysd/changelog-from-release/releases/tag/v3.3.0) - 2022-08-23 - Add `args` input to [the action](https://github.com/rhysd/changelog-from-release/tree/master/action) to define command line arguments passed to `changelog-from-release` command. @@ -138,7 +138,7 @@ [Changes][v3.3.0] - + # [v3.2.0](https://github.com/rhysd/changelog-from-release/releases/tag/v3.2.0) - 2022-08-22 - Add `-l` option to set heading level of each release sections. For example, `-l 2` uses `##` instead of `#` for each release sections. @@ -148,7 +148,7 @@ [Changes][v3.2.0] - + # [v3.1.4](https://github.com/rhysd/changelog-from-release/releases/tag/v3.1.4) - 2022-08-10 - In previous release, references in link texts were fixed. But the fix was not perfect. Nested text node in a link node was still linked incorrectly and this release fixed the bug. For instance, `@foo` in `[_@foo_](...)` should not be linked where the text is in italic node in link node. @@ -156,7 +156,7 @@ [Changes][v3.1.4] - + # [v3.1.3](https://github.com/rhysd/changelog-from-release/releases/tag/v3.1.3) - 2022-08-08 - Do not references in link texts. Previously references in link texts like `[#1](...)` were linked to `[[#1](https://github.com/owner/repo/issues/1)](...)`. Now they are not linked and left as-is ([#12](https://github.com/rhysd/changelog-from-release/issues/12)). @@ -165,7 +165,7 @@ [Changes][v3.1.3] - + # [v3.1.2](https://github.com/rhysd/changelog-from-release/releases/tag/v3.1.2) - 2022-08-04 - Fixed `commit-summary-template` was not effective by renaming the input to `commit_summary_template`. Hyphens are not available in Docker actions. For example, when `v1.2.3` is released, the following step creates a commit with summary `chore(changelog): describe changes for "v1.2.3"`. @@ -180,7 +180,7 @@ [Changes][v3.1.2] - + # [v3.1.1](https://github.com/rhysd/changelog-from-release/releases/tag/v3.1.1) - 2022-08-04 - Use `git remote` instead of `git rev-parse` to retrieve a remote name of repository since `git rev-parse` sometimes returns an unexpected output for some reason. ([#6](https://github.com/rhysd/changelog-from-release/issues/6)) @@ -191,7 +191,7 @@ [Changes][v3.1.1] - + # [v3.1.0](https://github.com/rhysd/changelog-from-release/releases/tag/v3.1.0) - 2022-08-03 - Link commit references in release note automatically. For example, `85a7d9028ed70bc81224cb126e29e070dcc0aa1c` is converted to ``[`85a7d9028e`](https://github.com/owner/repo/commit/85a7d9028ed70bc81224cb126e29e070dcc0aa1c)``. Note that only full-length (40 characters) commit hashes are linked to avoid false positives. @@ -201,7 +201,7 @@ [Changes][v3.1.0] - + # [v3.0.0](https://github.com/rhysd/changelog-from-release/releases/tag/v3.0.0) - 2022-08-03 - **BREAKING:** Labels at head of list items are no longer converted to bold text. For example, a list item starting with `- Fix:` was converted to `- **Fix:**`, but it is no longer converted from v3.0.0. @@ -220,7 +220,7 @@ [Changes][v3.0.0] - + # [v2.2.5](https://github.com/rhysd/changelog-from-release/releases/tag/v2.2.5) - 2022-06-02 - Fix `changelog-from-release` command hangs when generating a changelog of repository which has more than 30 releases ([#8](https://github.com/rhysd/changelog-from-release/issues/8), [#10](https://github.com/rhysd/changelog-from-release/issues/10)) @@ -228,7 +228,7 @@ [Changes][v2.2.5] - + # [v2.2.4](https://github.com/rhysd/changelog-from-release/releases/tag/v2.2.4) - 2022-05-12 - Strip credentials in repository URLs ([#9](https://github.com/rhysd/changelog-from-release/issues/9)). @@ -239,7 +239,7 @@ [Changes][v2.2.4] - + # [v2.2.3](https://github.com/rhysd/changelog-from-release/releases/tag/v2.2.3) - 2021-09-26 - Improve: Introduce Go modules. Now this tool is installable via `go install` @@ -250,7 +250,7 @@ [Changes][v2.2.3] - + # [v2.2.2](https://github.com/rhysd/changelog-from-release/releases/tag/v2.2.2) - 2021-02-24 - Fix: Rename `github-token` input to `github_token` since `-` is not available for input names ([#4](https://github.com/rhysd/changelog-from-release/issues/4)) @@ -258,7 +258,7 @@ [Changes][v2.2.2] - + # [v2.2.0](https://github.com/rhysd/changelog-from-release/releases/tag/v2.2.0) - 2020-02-22 - New: Support `$GITHUB_API_BASE_URL` environment variable to configure API endpoint for GitHub Enterprise @@ -271,7 +271,7 @@ GITHUB_TOKEN=abcabcabcabcabcabcabc changelog-from-release > CHANGELOG.md [Changes][v2.2.0] - + # [v2.1.0](https://github.com/rhysd/changelog-from-release/releases/tag/v2.1.0) - 2020-02-20 - New: [Action](https://github.com/rhysd/changelog-from-release/tree/master/action) for [GitHub Actions]() was added. Updating your changelog file following the new release now can be automated easily. @@ -302,7 +302,7 @@ jobs: [Changes][v2.1.0] - + # [v2.0.0](https://github.com/rhysd/changelog-from-release/releases/tag/v2.0.0) - 2020-02-19 I decided to keep this tool as simple as possible. This release drops some features for simplification. @@ -324,7 +324,7 @@ $ git commit -m "Update changelog for $(git describe --tags)" [Changes][v2.0.0] - + # [v1.2.0](https://github.com/rhysd/changelog-from-release/releases/tag/v1.2.0) - 2020-02-18 - New: `-commit` option was added to make a new commit for the changelog updates automatically @@ -332,7 +332,7 @@ $ git commit -m "Update changelog for $(git describe --tags)" [Changes][v1.2.0] - + # [v1.1.3](https://github.com/rhysd/changelog-from-release/releases/tag/v1.1.3) - 2020-02-13 - Fix: Consider paging for getting releases from GitHub API @@ -341,7 +341,7 @@ $ git commit -m "Update changelog for $(git describe --tags)" [Changes][v1.1.3] - + # [v1.1.2](https://github.com/rhysd/changelog-from-release/releases/tag/v1.1.2) - 2019-11-16 - Fix: Codes in fences should not be modified @@ -349,7 +349,7 @@ $ git commit -m "Update changelog for $(git describe --tags)" [Changes][v1.1.2] - + # [v1.1.1](https://github.com/rhysd/changelog-from-release/releases/tag/v1.1.1) - 2018-11-14 - Fix: Fix emphasizing item header with bold, not italic @@ -357,7 +357,7 @@ $ git commit -m "Update changelog for $(git describe --tags)" [Changes][v1.1.1] - + # [v1.1.0](https://github.com/rhysd/changelog-from-release/releases/tag/v1.1.0) - 2018-11-14 - Improve: Emphasize list item headers like `- *Fix:* Fix something` @@ -365,7 +365,7 @@ $ git commit -m "Update changelog for $(git describe --tags)" [Changes][v1.1.0] - + # [v1.0.0](https://github.com/rhysd/changelog-from-release/releases/tag/v1.0.0) - 2018-11-10 First release :tada: diff --git a/changelog.go b/changelog.go index 0f99130..364713f 100644 --- a/changelog.go +++ b/changelog.go @@ -92,7 +92,7 @@ func GenerateChangeLog(c *Config, p *Project) ([]byte, error) { compareURL = fmt.Sprintf("%s/compare/%s...%s", url, prevTag, tag) } - fmt.Fprintf(&out, "\n", tag) + fmt.Fprintf(&out, "\n", tag) if title == "" { title = tag diff --git a/main_test.go b/main_test.go index b44e611..889cacd 100644 --- a/main_test.go +++ b/main_test.go @@ -90,7 +90,7 @@ func TestGenerateWithRemoteURL(t *testing.T) { link = fmt.Sprintf("[%s]: https://github.com/rhysd/action-setup-vim/compare/", v) } for _, want := range []string{ - fmt.Sprintf(``, v), + fmt.Sprintf(``, v), fmt.Sprintf(`# [%s](https://github.com/rhysd/action-setup-vim/releases/tag/%s)`, v, v), fmt.Sprintf(`[Changes][%s]`, v), fmt.Sprintf(`[Changes][%s]`, v),