Use custom changelog generator #3415
Conversation
💥 No ChangesetLatest commit: d305d52 Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂 If these changes should be published to npm, you need to add a changeset. This PR includes no changesetsWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Click here to learn what changesets are, and how to add one. Click here if you're a maintainer who wants to add a changeset to this PR |
| @@ -0,0 +1,3 @@ | |||
| # @firebase/changelog-generator | |||
|
|
|||
| It's works as plugin for @changesets/cli to generate changelog entries(via running `changeset version`). | |||
There was a problem hiding this comment.
s/It's/It or "This module"
| return ''; | ||
| } | ||
| const issueNumber = match[3]; | ||
| return `Fixed [issue #${issueNumber}](https://github.com/firebase/firebase-js-sdk/issues/${issueNumber})`; |
There was a problem hiding this comment.
Could we do something like (fixes [#${issueNumber}])? It's a bit shorter and conveys the same information.
There was a problem hiding this comment.
I did that initially, but thought people may confuse the PR number with the issue number and adding string issue makes it a bit clearer.
Otherwise the generated line would look like this #3224 fixes #3158. Do you find it clear or confusing?
There was a problem hiding this comment.
I am very accustomed to this style, so it is not confusing to me. I do think the parenthesis might help.
We could also add it to the end:
9c409ea74 #3224 - [fix] Updated the TypeScript types for all APIs using Observers to allow callback omission (issue #3158).
I leave this up to your capable hands :)
There was a problem hiding this comment.
Ah, I didn't see the parenthesis. It certainly helps. Will adopt your suggestion.
I don't like putting it in the end because it's less discoverable, especially when the description is long.
It differs from
@changesets/changelog-githubin 2 waysAn example entry generated by the custom generator