Use custom changelog generator #3415
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json", | ||
| "changelog": ["../repo-scripts/changelog-generator", { "repo": "firebase/firebase-js-sdk"}], | ||
| "commit": false, | ||
| "linked": [], | ||
| "access": "public", | ||
|
|
||
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2020 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| module.exports = { | ||
| extends: '../../config/.eslintrc.js', | ||
| parserOptions: { | ||
| project: 'tsconfig.json', | ||
| // to make vscode-eslint work with monorepo | ||
| // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-463943250 | ||
| tsconfigRootDir: __dirname | ||
| } | ||
| }; |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # @firebase/changelog-generator | ||
|
|
||
| It's works as plugin for @changesets/cli to generate changelog entries(via running `changeset version`). | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2020 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { ChangelogFunctions } from '@changesets/types'; | ||
| import { getInfo } from '@changesets/get-github-info'; | ||
| import fetch from 'node-fetch'; | ||
|
|
||
| const changelogFunctions: ChangelogFunctions = { | ||
| getDependencyReleaseLine: async ( | ||
| changesets, | ||
| dependenciesUpdated, | ||
| options | ||
| ) => { | ||
| if (!options.repo) { | ||
| throw new Error( | ||
| 'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]' | ||
| ); | ||
| } | ||
| if (dependenciesUpdated.length === 0) return ''; | ||
|
|
||
| const changesetLink = `- Updated dependencies [${( | ||
| await Promise.all( | ||
| changesets.map(async cs => { | ||
| if (cs.commit) { | ||
| let { links } = await getInfo({ | ||
| repo: options.repo, | ||
| commit: cs.commit | ||
| }); | ||
| return links.commit; | ||
| } | ||
| }) | ||
| ) | ||
| ) | ||
| .filter(_ => _) | ||
| .join(', ')}]:`; | ||
|
|
||
| const updatedDepenenciesList = dependenciesUpdated.map( | ||
| dependency => ` - ${dependency.name}@${dependency.newVersion}` | ||
| ); | ||
|
|
||
| return [changesetLink, ...updatedDepenenciesList].join('\n'); | ||
| }, | ||
| getReleaseLine: async (changeset, type, options) => { | ||
| if (!options || !options.repo) { | ||
| throw new Error( | ||
| 'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]' | ||
| ); | ||
| } | ||
| const [firstLine, ...futureLines] = changeset.summary | ||
| .split('\n') | ||
| .map(l => l.trimRight()); | ||
|
|
||
| if (changeset.commit) { | ||
| let { pull: pullNumber, links } = await getInfo({ | ||
| repo: options.repo, | ||
| commit: changeset.commit | ||
| }); | ||
|
|
||
| let fixedIssueLink = null; | ||
| // If the summary didn't mention any issue, we will look at the PR body to try to generate one automatically | ||
| if (!/issues\/[\d+]/i.test(changeset.summary) && pullNumber) { | ||
| fixedIssueLink = await getFixedIssueLink(pullNumber, options.repo); | ||
| } | ||
|
|
||
| return `\n\n- ${links.commit}${ | ||
| links.pull === null ? '' : ` ${links.pull}` | ||
| }${ | ||
| fixedIssueLink === null ? '' : ` ${fixedIssueLink}` | ||
| } - ${firstLine}\n${futureLines.map(l => ` ${l}`).join('\n')}`; | ||
| } else { | ||
| return `\n\n- ${firstLine}\n${futureLines.map(l => ` ${l}`).join('\n')}`; | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const fixedIssueRegex = /(close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved) [^\s]*(#|issues\/)([\d]+)/i; | ||
| async function getFixedIssueLink( | ||
| prNumber: number, | ||
| repo: string | ||
| ): Promise<string> { | ||
| const { body }: { body: string } = await fetch( | ||
| `https://api.github.com/repos/${repo}/pulls/${prNumber}?access_token=${process.env.GITHUB_TOKEN}`, | ||
| { | ||
| method: 'GET' | ||
| } | ||
| ).then(data => data.json()); | ||
|
|
||
| const match = fixedIssueRegex.exec(body); | ||
| if (!match) { | ||
| 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 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 Otherwise the generated line would look like this 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: 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. |
||
| } | ||
|
|
||
| exports.default = changelogFunctions; | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| { | ||
| "name": "@firebase/changelog-generator", | ||
| "version": "0.1.0", | ||
| "private": true, | ||
| "description": "A package for generating changelog", | ||
| "author": "Firebase <[email protected]> (https://firebase.google.com/)", | ||
| "main": "dist/index.js", | ||
| "files": [ | ||
| "dist" | ||
| ], | ||
| "scripts": { | ||
| "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", | ||
| "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", | ||
| "build": "tsc", | ||
| "build:dev": "tsc -w", | ||
| "test": "yarn type-check", | ||
| "prepare": "yarn build" | ||
| }, | ||
| "dependencies": { | ||
| "@changesets/types": "3.1.0", | ||
| "@changesets/get-github-info": "0.4.3", | ||
| "node-fetch": "2.6.0", | ||
| "@types/node-fetch": "2.5.7" | ||
| }, | ||
| "license": "Apache-2.0", | ||
| "devDependencies": { | ||
| "typescript": "3.9.6" | ||
| }, | ||
| "repository": { | ||
| "directory": "repo-scripts/changelog-generator", | ||
| "type": "git", | ||
| "url": "https://github.com/firebase/firebase-js-sdk.git" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/firebase/firebase-js-sdk/issues" | ||
| }, | ||
| "nyc": { | ||
| "extension": [ | ||
| ".ts" | ||
| ], | ||
| "reportDir": "./coverage/node" | ||
| } | ||
| } |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "strict": true, | ||
| "outDir": "dist", | ||
| "lib": [ | ||
| "ESNext" | ||
| ], | ||
| "module": "CommonJS", | ||
| "moduleResolution": "node", | ||
| "esModuleInterop": true, | ||
| "resolveJsonModule": true, | ||
| "target": "es5", | ||
| "typeRoots": [ | ||
| "../../node_modules/@types" | ||
| ] | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1141,7 +1141,7 @@ | |
| fs-extra "^7.0.1" | ||
| semver "^5.4.1" | ||
|
|
||
| "@changesets/get-github-info@0.4.3", "@changesets/get-github-info@^0.4.3": | ||
| version "0.4.3" | ||
| resolved "https://registry.npmjs.org/@changesets/get-github-info/-/get-github-info-0.4.3.tgz#ed3c3ca76dcbaf4c98aa950a20fc5438da1a2f2c" | ||
| integrity sha512-hMtNDn4Kp2wDUohYipBIH3qGMxONZ3wEoaGtrflXHCSu57iulBcOSQ1oHRYSCJ9pO87dYQHA2XRUfrZUnqRfKA== | ||
|
|
@@ -1219,16 +1219,16 @@ | |
| fs-extra "^7.0.1" | ||
| p-filter "^2.1.0" | ||
|
|
||
| "@changesets/[email protected]", "@changesets/types@^3.1.0": | ||
| version "3.1.0" | ||
| resolved "https://registry.npmjs.org/@changesets/types/-/types-3.1.0.tgz#68957af45a0be29f0908e20a990ecf382282e1f1" | ||
| integrity sha512-czOfaaxr5aGnNwVRgWr3n2CKoc3iRTfrHM4wUHQ+rBlLKKk9NzGwZ2EPsXkp4CUw4hWHGEOi8hdeIfDTWKrWgg== | ||
|
|
||
| "@changesets/types@^3.0.0": | ||
| version "3.0.0" | ||
| resolved "https://registry.npmjs.org/@changesets/types/-/types-3.0.0.tgz#3804662aa455c1622282ec3253cf6ddd309eee65" | ||
| integrity sha512-9Mh/JqkX3nkjfu53ESM3UjFmR2meOo4Zw+Tp4vnon0XYtMurk7KjZG5L+J0fD3+Qx0A2FFTZrgydPwiHR4GrXQ== | ||
|
|
||
| "@changesets/write@^0.1.3": | ||
| version "0.1.3" | ||
| resolved "https://registry.npmjs.org/@changesets/write/-/write-0.1.3.tgz#00ae575af50274773d7493e77fb96838a08ad8ad" | ||
|
|
@@ -2620,6 +2620,14 @@ | |
| resolved "https://registry.npmjs.org/@types/mocha/-/mocha-7.0.2.tgz#b17f16cf933597e10d6d78eae3251e692ce8b0ce" | ||
| integrity sha512-ZvO2tAcjmMi8V/5Z3JsyofMe3hasRcaw88cto5etSVMwVQfeivGAlEYmaQgceUSVYFofVjT+ioHsATjdWcFt1w== | ||
|
|
||
| "@types/[email protected]": | ||
| version "2.5.7" | ||
| resolved "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.7.tgz#20a2afffa882ab04d44ca786449a276f9f6bbf3c" | ||
| integrity sha512-o2WVNf5UhWRkxlf6eq+jMZDu7kjgpgJfl4xVNlvryc95O/6F2ld8ztKX+qu+Rjyet93WAWm5LjeX9H5FGkODvw== | ||
| dependencies: | ||
| "@types/node" "*" | ||
| form-data "^3.0.0" | ||
|
|
||
| "@types/node@*", "@types/node@>= 8": | ||
| version "13.11.0" | ||
| resolved "https://registry.npmjs.org/@types/node/-/node-13.11.0.tgz#390ea202539c61c8fa6ba4428b57e05bc36dc47b" | ||
|
|
@@ -4858,7 +4866,7 @@ combine-source-map@^0.8.0, combine-source-map@~0.8.0: | |
| lodash.memoize "~3.0.3" | ||
| source-map "~0.5.3" | ||
|
|
||
| combined-stream@^1.0.6, combined-stream@^1.0.8, combined-stream@~1.0.6: | ||
| version "1.0.8" | ||
| resolved "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz#c3d45a8b34fd730631a110a8a2520682b31d5a7f" | ||
| integrity sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg== | ||
|
|
@@ -7090,6 +7098,15 @@ form-data@^2.5.0: | |
| combined-stream "^1.0.6" | ||
| mime-types "^2.1.12" | ||
|
|
||
| form-data@^3.0.0: | ||
| version "3.0.0" | ||
| resolved "https://registry.npmjs.org/form-data/-/form-data-3.0.0.tgz#31b7e39c85f1355b7139ee0c647cf0de7f83c682" | ||
| integrity sha512-CKMFDglpbMi6PyN+brwB9Q/GOw0eAnsrEZDgcsH5Krhz5Od/haKHAX0NmQfha2zPPz0JpWzA7GJHGSnvCRLWsg== | ||
| dependencies: | ||
| asynckit "^0.4.0" | ||
| combined-stream "^1.0.8" | ||
| mime-types "^2.1.12" | ||
|
|
||
| form-data@~2.3.2: | ||
| version "2.3.3" | ||
| resolved "https://registry.npmjs.org/form-data/-/form-data-2.3.3.tgz#dcce52c05f644f298c6a7ab936bd724ceffbf3a6" | ||
|
|
@@ -14195,7 +14212,6 @@ symbol-observable@^1.1.0: | |
|
|
||
| "sync-promise@git+https://github.com/brettz9/sync-promise.git#full-sync-missing-promise-features": | ||
| version "1.0.1" | ||
| resolved "git+https://github.com/brettz9/sync-promise.git#25845a49a00aa2d2c985a5149b97c86a1fcdc75a" | ||
|
|
||
| syntax-error@^1.1.1: | ||
|
|
@@ -15509,7 +15525,6 @@ websocket-extensions@>=0.1.1: | |
|
|
||
| "websql@git+https://github.com/brettz9/node-websql.git#configurable-secure2": | ||
| version "1.0.0" | ||
| resolved "git+https://github.com/brettz9/node-websql.git#5149bc0763376ca757fc32dc74345ada0467bfbb" | ||
| dependencies: | ||
| argsarray "^0.0.1" | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/It's/It or "This module"