From da6a302d0fb708401a0a423590530873c67045f2 Mon Sep 17 00:00:00 2001 From: cryptodev-2s <109512101+cryptodev-2s@users.noreply.github.com> Date: Wed, 20 Dec 2023 00:23:14 +0100 Subject: [PATCH] Add script to update changelogs of a release candidate (#3668) --- constraints.pro | 10 +++ package.json | 1 + packages/accounts-controller/package.json | 3 +- packages/address-book-controller/package.json | 3 +- packages/announcement-controller/package.json | 3 +- packages/approval-controller/package.json | 3 +- packages/assets-controllers/package.json | 3 +- packages/base-controller/package.json | 3 +- packages/build-utils/package.json | 3 +- packages/composable-controller/package.json | 3 +- packages/controller-utils/package.json | 3 +- packages/ens-controller/package.json | 3 +- packages/eth-json-rpc-provider/package.json | 3 +- packages/gas-fee-controller/package.json | 3 +- packages/json-rpc-engine/package.json | 3 +- .../json-rpc-middleware-stream/package.json | 3 +- packages/keyring-controller/package.json | 3 +- packages/logging-controller/package.json | 3 +- packages/message-manager/package.json | 3 +- packages/name-controller/package.json | 3 +- packages/network-controller/package.json | 3 +- packages/notification-controller/package.json | 3 +- packages/permission-controller/package.json | 3 +- .../permission-log-controller/package.json | 3 +- packages/phishing-controller/package.json | 3 +- packages/polling-controller/package.json | 3 +- packages/preferences-controller/package.json | 3 +- .../queued-request-controller/package.json | 3 +- packages/rate-limit-controller/package.json | 3 +- .../selected-network-controller/package.json | 3 +- packages/signature-controller/package.json | 3 +- packages/transaction-controller/package.json | 3 +- .../user-operation-controller/package.json | 3 +- .../package-template/package.json | 2 +- scripts/update-changelog.sh | 21 ++++++ yarn.lock | 70 +++++++++---------- 36 files changed, 130 insertions(+), 67 deletions(-) create mode 100755 scripts/update-changelog.sh diff --git a/constraints.pro b/constraints.pro index 59e07bbc09..1868562675 100644 --- a/constraints.pro +++ b/constraints.pro @@ -276,6 +276,16 @@ gen_enforced_field(WorkspaceCwd, 'scripts.changelog:validate', CorrectChangelogV atom_concat('../../scripts/validate-changelog.sh ', WorkspacePackageName, ExpectedPrefix), \+ atom_concat(ExpectedPrefix, _, ChangelogValidationCommand). +% The "changelog:update" script for each published package must run a common +% script with the name of the package as the first argument. +gen_enforced_field(WorkspaceCwd, 'scripts.changelog:update', CorrectChangelogUpdateCommand) :- + \+ workspace_field(WorkspaceCwd, 'private', true), + workspace_field(WorkspaceCwd, 'scripts.changelog:update', ChangelogUpdateCommand), + workspace_package_name(WorkspaceCwd, WorkspacePackageName), + atomic_list_concat(['../../scripts/update-changelog.sh ', WorkspacePackageName, ' [...]'], CorrectChangelogUpdateCommand), + atom_concat('../../scripts/update-changelog.sh ', WorkspacePackageName, ExpectedPrefix), + \+ atom_concat(ExpectedPrefix, _, ChangelogUpdateCommand). + % All non-root packages must have the same "test" script. gen_enforced_field(WorkspaceCwd, 'scripts.test', 'jest --reporters=jest-silent-reporter') :- WorkspaceCwd \= '.'. diff --git a/package.json b/package.json index 35f4f4118a..3f841163ba 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ "build:clean": "rimraf dist '**/*.tsbuildinfo' && yarn build", "build:docs": "yarn workspaces foreach --parallel --interlaced --verbose run build:docs", "build:watch": "yarn run build --watch", + "changelog:update": "yarn workspaces foreach --parallel --interlaced --verbose run changelog:update", "changelog:validate": "yarn workspaces foreach --parallel --interlaced --verbose run changelog:validate", "child-workspace-package-names-as-json": "ts-node scripts/child-workspace-package-names-as-json.ts", "create-package": "ts-node scripts/create-package", diff --git a/packages/accounts-controller/package.json b/packages/accounts-controller/package.json index 6c9275aaa0..dedbe1039f 100644 --- a/packages/accounts-controller/package.json +++ b/packages/accounts-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/accounts-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/accounts-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -41,7 +42,7 @@ "uuid": "^8.3.2" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@metamask/keyring-controller": "^10.0.0", "@metamask/snaps-controllers": "^3.2.0", "@types/jest": "^27.4.1", diff --git a/packages/address-book-controller/package.json b/packages/address-book-controller/package.json index f6082c15cb..11702ff3f7 100644 --- a/packages/address-book-controller/package.json +++ b/packages/address-book-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/address-book-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/address-book-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -35,7 +36,7 @@ "@metamask/utils": "^8.2.0" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/announcement-controller/package.json b/packages/announcement-controller/package.json index af395df2c2..342ab94159 100644 --- a/packages/announcement-controller/package.json +++ b/packages/announcement-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/announcement-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/announcement-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -33,7 +34,7 @@ "@metamask/base-controller": "^4.0.0" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/approval-controller/package.json b/packages/approval-controller/package.json index 2831dd9283..146fab6615 100644 --- a/packages/approval-controller/package.json +++ b/packages/approval-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/approval-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/approval-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -36,7 +37,7 @@ "nanoid": "^3.1.31" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/assets-controllers/package.json b/packages/assets-controllers/package.json index 1778745a1f..e5a4f4fdfd 100644 --- a/packages/assets-controllers/package.json +++ b/packages/assets-controllers/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/assets-controllers", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/assets-controllers", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -56,7 +57,7 @@ "uuid": "^8.3.2" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@metamask/ethjs-provider-http": "^0.2.0", "@types/jest": "^27.4.1", "@types/lodash": "^4.14.191", diff --git a/packages/base-controller/package.json b/packages/base-controller/package.json index b9e96696b2..76e9ff25bc 100644 --- a/packages/base-controller/package.json +++ b/packages/base-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/base-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/base-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -34,7 +35,7 @@ "immer": "^9.0.6" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "@types/sinon": "^9.0.10", "deepmerge": "^4.2.2", diff --git a/packages/build-utils/package.json b/packages/build-utils/package.json index 3f9cde27a2..3a05509ea1 100644 --- a/packages/build-utils/package.json +++ b/packages/build-utils/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/build-utils", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/build-utils", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -34,7 +35,7 @@ "@types/eslint": "^8.44.7" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "eslint": "^8.44.0", diff --git a/packages/composable-controller/package.json b/packages/composable-controller/package.json index 50afea72d9..855d0bac0c 100644 --- a/packages/composable-controller/package.json +++ b/packages/composable-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/composable-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/composable-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -33,7 +34,7 @@ "@metamask/base-controller": "^4.0.0" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "immer": "^9.0.6", diff --git a/packages/controller-utils/package.json b/packages/controller-utils/package.json index f981df0da4..89138eed0d 100644 --- a/packages/controller-utils/package.json +++ b/packages/controller-utils/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/controller-utils", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/controller-utils", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -39,7 +40,7 @@ "fast-deep-equal": "^3.1.3" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "bn.js": "^5.2.1", "deepmerge": "^4.2.2", diff --git a/packages/ens-controller/package.json b/packages/ens-controller/package.json index eff1496af9..28df8a2b73 100644 --- a/packages/ens-controller/package.json +++ b/packages/ens-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/ens-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/ens-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -39,7 +40,7 @@ "punycode": "^2.1.1" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/eth-json-rpc-provider/package.json b/packages/eth-json-rpc-provider/package.json index 371b8dfda3..02a4e4d14b 100644 --- a/packages/eth-json-rpc-provider/package.json +++ b/packages/eth-json-rpc-provider/package.json @@ -24,6 +24,7 @@ "build": "tsc --project tsconfig.build.json", "build:clean": "rimraf dist && yarn build", "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/eth-json-rpc-provider", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/eth-json-rpc-provider", "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:dependencies", "lint:dependencies": "depcheck", @@ -42,7 +43,7 @@ "@metamask/utils": "^8.2.0" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/gas-fee-controller/package.json b/packages/gas-fee-controller/package.json index 09ecbda4f2..fb081c6d80 100644 --- a/packages/gas-fee-controller/package.json +++ b/packages/gas-fee-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/gas-fee-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/gas-fee-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -42,7 +43,7 @@ "uuid": "^8.3.2" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "@types/jest-when": "^2.7.3", "deepmerge": "^4.2.2", diff --git a/packages/json-rpc-engine/package.json b/packages/json-rpc-engine/package.json index 2427a13db5..c45927d182 100644 --- a/packages/json-rpc-engine/package.json +++ b/packages/json-rpc-engine/package.json @@ -27,6 +27,7 @@ "build": "tsc --project tsconfig.build.json", "build:clean": "rimraf dist && yarn build", "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/json-rpc-engine --tag-prefix-before-package-rename json-rpc-engine@ --version-before-package-rename 6.1.0", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/json-rpc-engine --tag-prefix-before-package-rename json-rpc-engine@ --version-before-package-rename 6.1.0", "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:dependencies && yarn lint:changelog", "lint:changelog": "auto-changelog validate", @@ -47,7 +48,7 @@ }, "devDependencies": { "@lavamoat/allow-scripts": "^2.3.1", - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/json-rpc-middleware-stream/package.json b/packages/json-rpc-middleware-stream/package.json index 403e815198..b7df70b3d5 100644 --- a/packages/json-rpc-middleware-stream/package.json +++ b/packages/json-rpc-middleware-stream/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/json-rpc-middleware-stream --tag-prefix-before-package-rename json-rpc-middleware-stream@ --version-before-package-rename 5.0.1", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/json-rpc-middleware-stream --tag-prefix-before-package-rename json-rpc-middleware-stream@ --version-before-package-rename 5.0.1", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -36,7 +37,7 @@ "readable-stream": "^3.6.2" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "@types/readable-stream": "^2.3.0", "deepmerge": "^4.2.2", diff --git a/packages/keyring-controller/package.json b/packages/keyring-controller/package.json index c9403225c7..d315dc53c5 100644 --- a/packages/keyring-controller/package.json +++ b/packages/keyring-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/keyring-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/keyring-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -45,7 +46,7 @@ "@ethereumjs/common": "^3.2.0", "@ethereumjs/tx": "^4.2.0", "@keystonehq/bc-ur-registry-eth": "^0.9.0", - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@metamask/eth-sig-util": "^7.0.1", "@metamask/scure-bip39": "^2.1.1", "@types/jest": "^27.4.1", diff --git a/packages/logging-controller/package.json b/packages/logging-controller/package.json index a81a44d3b6..d35d2a832f 100644 --- a/packages/logging-controller/package.json +++ b/packages/logging-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/logging-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/logging-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -35,7 +36,7 @@ "uuid": "^8.3.2" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/message-manager/package.json b/packages/message-manager/package.json index 5529a5d5bb..8ed148378d 100644 --- a/packages/message-manager/package.json +++ b/packages/message-manager/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/message-manager", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/message-manager", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -40,7 +41,7 @@ "uuid": "^8.3.2" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/name-controller/package.json b/packages/name-controller/package.json index 95a858e847..a3d0efb992 100644 --- a/packages/name-controller/package.json +++ b/packages/name-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/name-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/name-controller", "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh", "publish:preview": "yarn npm publish --tag preview", @@ -36,7 +37,7 @@ "async-mutex": "^0.2.6" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/network-controller/package.json b/packages/network-controller/package.json index 5e3a658627..bf569b064d 100644 --- a/packages/network-controller/package.json +++ b/packages/network-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/network-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/network-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -47,7 +48,7 @@ }, "devDependencies": { "@json-rpc-specification/meta-schema": "^1.0.6", - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "@types/jest-when": "^2.7.3", "@types/lodash": "^4.14.191", diff --git a/packages/notification-controller/package.json b/packages/notification-controller/package.json index b84aff4535..746d345bdb 100644 --- a/packages/notification-controller/package.json +++ b/packages/notification-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/notification-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/notification-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -35,7 +36,7 @@ "nanoid": "^3.1.31" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/permission-controller/package.json b/packages/permission-controller/package.json index f636cda039..133ddaff36 100644 --- a/packages/permission-controller/package.json +++ b/packages/permission-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/permission-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/permission-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -42,7 +43,7 @@ "nanoid": "^3.1.31" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/permission-log-controller/package.json b/packages/permission-log-controller/package.json index 650cd4d767..fd2d53ea26 100644 --- a/packages/permission-log-controller/package.json +++ b/packages/permission-log-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/permission-log-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/permission-log-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -35,7 +36,7 @@ "@metamask/utils": "^8.2.0" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/deep-freeze-strict": "^1.1.0", "@types/jest": "^27.4.1", "deep-freeze-strict": "^1.1.1", diff --git a/packages/phishing-controller/package.json b/packages/phishing-controller/package.json index 690df38cd5..578efe2738 100644 --- a/packages/phishing-controller/package.json +++ b/packages/phishing-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/phishing-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/phishing-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -37,7 +38,7 @@ "punycode": "^2.1.1" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/polling-controller/package.json b/packages/polling-controller/package.json index 30fcdec8e0..784d5e2e91 100644 --- a/packages/polling-controller/package.json +++ b/packages/polling-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/polling-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/polling-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -39,7 +40,7 @@ "uuid": "^8.3.2" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/preferences-controller/package.json b/packages/preferences-controller/package.json index 0e63904ae0..25ecfa264f 100644 --- a/packages/preferences-controller/package.json +++ b/packages/preferences-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/preferences-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/preferences-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -34,7 +35,7 @@ "@metamask/controller-utils": "^8.0.0" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/queued-request-controller/package.json b/packages/queued-request-controller/package.json index 08bc1cb921..f78237b82d 100644 --- a/packages/queued-request-controller/package.json +++ b/packages/queued-request-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/queued-request-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/queued-request-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -41,7 +42,7 @@ "@metamask/utils": "^8.2.0" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "immer": "^9.0.6", diff --git a/packages/rate-limit-controller/package.json b/packages/rate-limit-controller/package.json index d3a06b0750..7189d8f016 100644 --- a/packages/rate-limit-controller/package.json +++ b/packages/rate-limit-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/rate-limit-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/rate-limit-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -34,7 +35,7 @@ "@metamask/rpc-errors": "^6.1.0" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/selected-network-controller/package.json b/packages/selected-network-controller/package.json index 67f89f8ef7..60e816a617 100644 --- a/packages/selected-network-controller/package.json +++ b/packages/selected-network-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/selected-network-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/selected-network-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -37,7 +38,7 @@ "@metamask/utils": "^8.2.0" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "immer": "^9.0.6", diff --git a/packages/signature-controller/package.json b/packages/signature-controller/package.json index 1eb0c7a476..b254a26bfa 100644 --- a/packages/signature-controller/package.json +++ b/packages/signature-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/signature-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/signature-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -42,7 +43,7 @@ "lodash": "^4.17.21" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/packages/transaction-controller/package.json b/packages/transaction-controller/package.json index f374858c19..189b85e1a0 100644 --- a/packages/transaction-controller/package.json +++ b/packages/transaction-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/transaction-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/transaction-controller", "publish:preview": "yarn npm publish --tag preview", "test": "jest --reporters=jest-silent-reporter", @@ -51,7 +52,7 @@ "uuid": "^8.3.2" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@metamask/ethjs-provider-http": "^0.2.0", "@types/jest": "^27.4.1", "@types/node": "^16.18.54", diff --git a/packages/user-operation-controller/package.json b/packages/user-operation-controller/package.json index 1b60b0d9c8..a6c8b7cccb 100644 --- a/packages/user-operation-controller/package.json +++ b/packages/user-operation-controller/package.json @@ -22,6 +22,7 @@ ], "scripts": { "build:docs": "typedoc", + "changelog:update": "../../scripts/update-changelog.sh @metamask/user-operation-controller", "changelog:validate": "../../scripts/validate-changelog.sh @metamask/user-operation-controller", "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh", "publish:preview": "yarn npm publish --tag preview", @@ -46,7 +47,7 @@ "uuid": "^8.3.2" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/scripts/create-package/package-template/package.json b/scripts/create-package/package-template/package.json index 12858f94d7..96f486a3a7 100644 --- a/scripts/create-package/package-template/package.json +++ b/scripts/create-package/package-template/package.json @@ -30,7 +30,7 @@ "test:watch": "jest --watch" }, "devDependencies": { - "@metamask/auto-changelog": "^3.4.3", + "@metamask/auto-changelog": "^3.4.4", "@types/jest": "^27.4.1", "deepmerge": "^4.2.2", "jest": "^27.5.1", diff --git a/scripts/update-changelog.sh b/scripts/update-changelog.sh new file mode 100755 index 0000000000..0655bc92e5 --- /dev/null +++ b/scripts/update-changelog.sh @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +set -euo pipefail + +# Get the current package name +if [[ $# -eq 0 ]]; then + echo "Missing package name." + exit 1 +fi + +package_name="$1" +shift # remove package name from arguments + +# Get the current git branch +branch=$(git rev-parse --abbrev-ref HEAD) + +if [[ $branch =~ ^release/ ]]; then + yarn auto-changelog update --tag-prefix "${package_name}@" --rc "$@" +else + yarn auto-changelog update --tag-prefix "${package_name}@" "$@" +fi diff --git a/yarn.lock b/yarn.lock index b7c1181db1..ffc6064564 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1472,7 +1472,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/accounts-controller@workspace:packages/accounts-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/eth-snap-keyring": ^2.0.0 "@metamask/keyring-api": ^1.1.0 @@ -1511,7 +1511,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/address-book-controller@workspace:packages/address-book-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/utils": ^8.2.0 @@ -1529,7 +1529,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/announcement-controller@workspace:packages/announcement-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@types/jest": ^27.4.1 deepmerge: ^4.2.2 @@ -1545,7 +1545,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/approval-controller@workspace:packages/approval-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/rpc-errors": ^6.1.0 "@metamask/utils": ^8.2.0 @@ -1584,7 +1584,7 @@ __metadata: "@ethersproject/providers": ^5.7.0 "@metamask/abi-utils": ^2.0.2 "@metamask/approval-controller": ^5.1.0 - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/contract-metadata": ^2.4.0 "@metamask/controller-utils": ^8.0.0 @@ -1623,9 +1623,9 @@ __metadata: languageName: unknown linkType: soft -"@metamask/auto-changelog@npm:^3.4.3": - version: 3.4.3 - resolution: "@metamask/auto-changelog@npm:3.4.3" +"@metamask/auto-changelog@npm:^3.4.4": + version: 3.4.4 + resolution: "@metamask/auto-changelog@npm:3.4.4" dependencies: diff: ^5.0.0 execa: ^5.1.1 @@ -1634,7 +1634,7 @@ __metadata: yargs: ^17.0.1 bin: auto-changelog: dist/cli.js - checksum: 3405f1f85d02684a95945ab253523619014bdae5da6121fb540140f8b21ddf2dda104683d91a24176c4c67a44fb9446d2e607d94a532a2bbb4f08a08a1e5a605 + checksum: 4876ab3ec98f6d0c00a0679f9e44e1ee79d335ae97e18336a638ac19484cac30d2f3750e6875121ee07b0da128f8609490bed0e195c8153c2b74866f34e405ed languageName: node linkType: hard @@ -1657,7 +1657,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/base-controller@workspace:packages/base-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/utils": ^8.2.0 "@types/jest": ^27.4.1 "@types/sinon": ^9.0.10 @@ -1695,7 +1695,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/build-utils@workspace:packages/build-utils" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/utils": ^8.2.0 "@types/eslint": ^8.44.7 "@types/jest": ^27.4.1 @@ -1713,7 +1713,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/composable-controller@workspace:packages/composable-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@types/jest": ^27.4.1 deepmerge: ^4.2.2 @@ -1738,7 +1738,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/controller-utils@workspace:packages/controller-utils" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/eth-query": ^4.0.0 "@metamask/ethjs-unit": ^0.2.1 "@metamask/utils": ^8.2.0 @@ -1846,7 +1846,7 @@ __metadata: resolution: "@metamask/ens-controller@workspace:packages/ens-controller" dependencies: "@ethersproject/providers": ^5.7.0 - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/network-controller": ^17.0.0 @@ -1962,7 +1962,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/eth-json-rpc-provider@workspace:packages/eth-json-rpc-provider" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/json-rpc-engine": ^7.3.0 "@metamask/safe-event-emitter": ^3.0.0 "@metamask/utils": ^8.2.0 @@ -2077,7 +2077,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/gas-fee-controller@workspace:packages/gas-fee-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/eth-query": ^4.0.0 @@ -2109,7 +2109,7 @@ __metadata: resolution: "@metamask/json-rpc-engine@workspace:packages/json-rpc-engine" dependencies: "@lavamoat/allow-scripts": ^2.3.1 - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/rpc-errors": ^6.1.0 "@metamask/safe-event-emitter": ^3.0.0 "@metamask/utils": ^8.2.0 @@ -2127,7 +2127,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/json-rpc-middleware-stream@workspace:packages/json-rpc-middleware-stream" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/json-rpc-engine": ^7.3.0 "@metamask/safe-event-emitter": ^3.0.0 "@metamask/utils": ^8.2.0 @@ -2184,7 +2184,7 @@ __metadata: "@ethereumjs/tx": ^4.2.0 "@keystonehq/bc-ur-registry-eth": ^0.9.0 "@keystonehq/metamask-airgapped-keyring": ^0.13.1 - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/eth-keyring-controller": ^15.1.0 "@metamask/eth-sig-util": ^7.0.1 @@ -2215,7 +2215,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/logging-controller@workspace:packages/logging-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@types/jest": ^27.4.1 @@ -2233,7 +2233,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/message-manager@workspace:packages/message-manager" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/eth-sig-util": ^7.0.1 @@ -2263,7 +2263,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/name-controller@workspace:packages/name-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/utils": ^8.2.0 "@types/jest": ^27.4.1 @@ -2282,7 +2282,7 @@ __metadata: resolution: "@metamask/network-controller@workspace:packages/network-controller" dependencies: "@json-rpc-specification/meta-schema": ^1.0.6 - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/eth-json-rpc-infura": ^9.0.0 @@ -2317,7 +2317,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/notification-controller@workspace:packages/notification-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/utils": ^8.2.0 "@types/jest": ^27.4.1 @@ -2387,7 +2387,7 @@ __metadata: resolution: "@metamask/permission-controller@workspace:packages/permission-controller" dependencies: "@metamask/approval-controller": ^5.1.0 - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/json-rpc-engine": ^7.3.0 @@ -2413,7 +2413,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/permission-log-controller@workspace:packages/permission-log-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/json-rpc-engine": ^7.3.0 "@metamask/utils": ^8.2.0 @@ -2448,7 +2448,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/phishing-controller@workspace:packages/phishing-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@types/jest": ^27.4.1 @@ -2470,7 +2470,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/polling-controller@workspace:packages/polling-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/network-controller": ^17.0.0 @@ -2505,7 +2505,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/preferences-controller@workspace:packages/preferences-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@types/jest": ^27.4.1 @@ -2542,7 +2542,7 @@ __metadata: resolution: "@metamask/queued-request-controller@workspace:packages/queued-request-controller" dependencies: "@metamask/approval-controller": ^5.1.0 - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/json-rpc-engine": ^7.3.0 @@ -2573,7 +2573,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/rate-limit-controller@workspace:packages/rate-limit-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/rpc-errors": ^6.1.0 "@types/jest": ^27.4.1 @@ -2624,7 +2624,7 @@ __metadata: version: 0.0.0-use.local resolution: "@metamask/selected-network-controller@workspace:packages/selected-network-controller" dependencies: - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/json-rpc-engine": ^7.3.0 "@metamask/network-controller": ^17.0.0 @@ -2651,7 +2651,7 @@ __metadata: resolution: "@metamask/signature-controller@workspace:packages/signature-controller" dependencies: "@metamask/approval-controller": ^5.1.0 - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/keyring-controller": ^10.0.0 @@ -2792,7 +2792,7 @@ __metadata: "@ethereumjs/tx": ^4.2.0 "@ethersproject/abi": ^5.7.0 "@metamask/approval-controller": ^5.1.0 - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/eth-query": ^4.0.0 @@ -2832,7 +2832,7 @@ __metadata: resolution: "@metamask/user-operation-controller@workspace:packages/user-operation-controller" dependencies: "@metamask/approval-controller": ^5.1.0 - "@metamask/auto-changelog": ^3.4.3 + "@metamask/auto-changelog": ^3.4.4 "@metamask/base-controller": ^4.0.0 "@metamask/controller-utils": ^8.0.0 "@metamask/eth-query": ^4.0.0