Add way to view pkg changes since latest release

mcmire · mcmire · commit 76ed164cc423 · 2024-04-30T10:05:48.000-06:00
When creating a new release, it can be helpful to be able to view the
changes that have been made to a package since its most recent release.
This commit adds a package script, `since-latest-release`, which can be
used to accomplish this.

This script is simply a shortcut for a commit range, so you can plug any
Git command that takes a commit range into it. For instance, to view the
list of latest commits for `@metamask/assets-controllers`, you can use
`log`:

    yarn workspace @metamask/assets-controllers since-latest-release log

Or to view all changes, you can use `diff`:

    yarn workspace @metamask/assets-controllers since-latest-release diff

Or you can leave an argument off to just get the names of commits:

    yarn workspace @metamask/assets-controllers since-latest-release
diff --git a/constraints.pro b/constraints.pro
@@ -327,6 +327,10 @@ gen_enforced_field(WorkspaceCwd, 'scripts.test:verbose', 'jest --verbose') :-
 gen_enforced_field(WorkspaceCwd, 'scripts.test:watch', 'jest --watch') :-
   WorkspaceCwd \= '.'.
 
+% All non-root packages must have the same "since-latest-release" script.
+gen_enforced_field(WorkspaceCwd, 'scripts.since-latest-release', '../../scripts/since-latest-release.sh') :-
+  WorkspaceCwd \= '.'.
+
 % All dependency ranges must be recognizable (this makes it possible to apply
 % the next two rules effectively).
 gen_enforced_dependency(WorkspaceCwd, DependencyIdent, 'a range optionally starting with ^ or ~', DependencyType) :-
diff --git a/packages/accounts-controller/package.json b/packages/accounts-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/address-book-controller/package.json b/packages/address-book-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/announcement-controller/package.json b/packages/announcement-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/approval-controller/package.json b/packages/approval-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/assets-controllers/package.json b/packages/assets-controllers/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/base-controller/package.json b/packages/base-controller/package.json
@@ -34,6 +34,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/build-utils/package.json b/packages/build-utils/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/composable-controller/package.json b/packages/composable-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/controller-utils/package.json b/packages/controller-utils/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/ens-controller/package.json b/packages/ens-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/eth-json-rpc-provider/package.json b/packages/eth-json-rpc-provider/package.json
@@ -40,6 +40,7 @@
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write && yarn lint:dependencies",
     "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/gas-fee-controller/package.json b/packages/gas-fee-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/json-rpc-engine/package.json b/packages/json-rpc-engine/package.json
@@ -44,6 +44,7 @@
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write && yarn lint:dependencies && yarn lint:changelog",
     "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/json-rpc-middleware-stream/package.json b/packages/json-rpc-middleware-stream/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/keyring-controller/package.json b/packages/keyring-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/logging-controller/package.json b/packages/logging-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/message-manager/package.json b/packages/message-manager/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/name-controller/package.json b/packages/name-controller/package.json
@@ -36,6 +36,7 @@
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/name-controller",
     "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/network-controller/package.json b/packages/network-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/notification-controller/package.json b/packages/notification-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/permission-controller/package.json b/packages/permission-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/permission-log-controller/package.json b/packages/permission-log-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/phishing-controller/package.json b/packages/phishing-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/polling-controller/package.json b/packages/polling-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/preferences-controller/package.json b/packages/preferences-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/queued-request-controller/package.json b/packages/queued-request-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/rate-limit-controller/package.json b/packages/rate-limit-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/selected-network-controller/package.json b/packages/selected-network-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/signature-controller/package.json b/packages/signature-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/transaction-controller/package.json b/packages/transaction-controller/package.json
@@ -35,6 +35,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/packages/user-operation-controller/package.json b/packages/user-operation-controller/package.json
@@ -36,6 +36,7 @@
     "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",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
     "test:verbose": "jest --verbose",
diff --git a/scripts/since-latest-release.sh b/scripts/since-latest-release.sh
@@ -0,0 +1,55 @@
+#!/bin/bash
+
+magenta() {
+  printf "\x1B[35m"
+  echo -n "$@"
+  printf "\x1B[0m"
+}
+
+bold() {
+  printf "\x1B[1m"
+  echo -n "$@"
+  printf "\x1B[22m"
+}
+
+previous-release-commit() {
+  git tag --sort=version:refname --list "$1@*" | tail -n 1
+}
+
+determine-commit-range() {
+  if [[ "$1" =~ ^release/ ]]; then
+    echo "$previous_release_commit..main"
+  else
+    echo "$previous_release_commit..HEAD"
+  fi
+}
+
+since-previous-release() {
+  local package_name
+  local package_directory
+  local git_command
+  local current_branch
+  local previous_release_commit
+  local commit_range
+
+  package_name="$npm_package_name"
+  package_directory="$PWD"
+
+  git_command=("$@")
+  if [[ ${#git_command[@]} -eq 0 ]]; then
+    git_command=(log --oneline)
+  fi
+
+  current_branch="$(git branch --show-current)"
+  previous_release_commit="$(previous-release-commit "$npm_package_name")"
+  commit_range="$(determine-commit-range "$current_branch")"
+
+  echo "$(magenta "$(bold "Package:")" "$package_name")"
+  echo "$(magenta "$(bold "Directory:")" "$package_directory")"
+  echo "$(magenta "$(bold "Commit range:")" "$commit_range")"
+  echo
+
+  git "${git_command[@]}" "$commit_range" -- "$PWD"
+}
+
+since-previous-release "$@"
