Use changesets for releases, use Node 20

.changeset/config.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": [
+    "@changesets/changelog-github",
+    {
+      "repo": "OpenZeppelin/openzeppelin-upgrades"
+    }
+  ],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "master",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/actions/setup/action.yml

@@ -5,7 +5,7 @@ runs:
   steps:
     - uses: actions/setup-node@v4
       with:
-        node-version: 18.x
+        node-version: 20.x
         cache: yarn
 
     - name: Install dependencies

.github/workflows/changeset.yml

@@ -0,0 +1,28 @@
+name: Changeset
+
+on:
+  pull_request:
+    branches:
+      - master
+    types:
+      - opened
+      - synchronize
+      - labeled
+      - unlabeled
+
+concurrency:
+  group: changeset-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    if: ${{ !contains(github.event.pull_request.labels.*.name, 'ignore-changeset') }}
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
+        with:
+          fetch-depth: 0 # Include history so Changesets finds merge-base
+      - name: Set up environment
+        uses: ./.github/actions/setup
+      - name: Check changeset
+        run: npx changeset status --since=origin/${{ github.base_ref }}

.github/workflows/publish.yml

@@ -0,0 +1,44 @@
+name: Publish Packages
+
+on:
+  workflow_dispatch:
+
+concurrency: version-or-publish-${{ github.ref }}
+
+jobs:
+  publish:
+    name: Publish Packages
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    environment: publish
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
+        with:
+          fetch-depth: 0 # To get all tags
+          ref: ${{ github.ref }}
+      - name: Set up environment
+        uses: ./.github/actions/setup
+      - name: Create Prepare Release PR or Publish
+        id: changesets
+        uses: changesets/action@001cd79f0a536e733315164543a727bdf2d70aff # v1.5.1
+        with:
+          title: Prepare Release
+          commit: Prepare Release
+          version: npm run version
+          publish: npm run publish
+          commitMode: github-api
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Check changesets status
+        if: steps.changesets.outputs.hasChangesets == 'true'
+        run: |
+          echo "Changesets found. Merge Prepare Release PR before publishing."
+          exit 1
+      - name: Check publish status
+        if: steps.changesets.outputs.published == 'false'
+        run: |
+          echo "Publish failed. Check the logs for more details."
+          exit 1

.github/workflows/version.yml

@@ -0,0 +1,34 @@
+name: Version Packages
+
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - 'docs/**'
+
+concurrency: version-or-publish-${{ github.ref }}
+
+jobs:
+  version:
+    name: Prepare Release PR
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
+        with:
+          fetch-depth: 0 # To get all tags
+          ref: ${{ github.ref }}
+      - name: Set up environment
+        uses: ./.github/actions/setup
+      - name: Create Prepare Release PR
+        uses: changesets/action@001cd79f0a536e733315164543a727bdf2d70aff # v1.5.1
+        with:
+          title: Prepare Release
+          commit: Prepare Release
+          version: npm run version
+          commitMode: github-api
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.node-version

@@ -1 +1 @@
-18
+20

CONTRIBUTING.md

@@ -31,3 +31,6 @@ If linting errors or warnings occur, run `yarn lint --fix` to attempt to auto-fi
 
 As a contributor, we ask that you fork this repository, work on your own fork and then submit pull requests. The pull requests will be reviewed and eventually merged into the main repo. See ["Fork-a-Repo"](https://help.github.com/articles/fork-a-repo/) for how this works.
 
+### Adding Changesets
+If your PR modifies code under `packages`, you will need to add a changeset to summarize the changes. The PR's `Changeset` GitHub check will give an error if this condition is not satisfied.
+- To add a changeset: from the root directory, run `yarn changeset`

package.json

@@ -10,7 +10,9 @@
     "lint": "yarn lint:path .",
     "lint:path": "eslint --ignore-path .gitignore --max-warnings 0",
     "test": "wsrun -ms test",
-    "coverage": "nyc yarn test"
+    "coverage": "nyc yarn test",
+    "version": "bash scripts/release/version.sh",
+    "publish": "bash scripts/release/publish.sh"
   },
   "devDependencies": {
     "@openzeppelin/docs-utils": "^0.1.0",
@@ -24,7 +26,9 @@
     "nyc": "^17.0.0",
     "prettier": "^3.0.0",
     "typescript": "^5.0.0",
-    "wsrun": "^5.2.4"
+    "wsrun": "^5.2.4",
+    "@changesets/cli": "^2.29.3",
+    "@changesets/changelog-github": "^0.5.1"
   },
   "workspaces": {
     "packages": [

packages/core/package.json

@@ -2,7 +2,7 @@
   "name": "@openzeppelin/upgrades-core",
   "version": "1.44.0",
   "description": "",
-  "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
+  "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades",
   "license": "MIT",
   "main": "dist/index.js",
   "files": [
@@ -38,7 +38,6 @@
     "test": "ava",
     "test:update-snapshots": "yarn test --update-snapshots",
     "test:watch": "hardhat compile --force && yarn copyfiles && fgbg 'ava --watch' 'tsc -b --watch' --",
-    "version": "node ../../scripts/bump-changelog.js",
     "cli": "node ./dist/cli/cli.js"
   },
   "bin": {
@@ -52,7 +51,7 @@
     "@types/debug": "^4.1.5",
     "@types/minimist": "^1.2.5",
     "@types/mocha": "^7.0.2",
-    "@types/node": "^16.11.7",
+    "@types/node": "^20.0.0",
     "@types/proper-lockfile": "^4.1.1",
     "@types/sinon": "^17.0.0",
     "ava": "^6.0.0",

packages/plugin-hardhat/package.json

@@ -2,7 +2,7 @@
   "name": "@openzeppelin/hardhat-upgrades",
   "version": "3.9.0",
   "description": "",
-  "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/plugin-hardhat",
+  "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades",
   "license": "MIT",
   "main": "dist/index.js",
   "files": [
@@ -15,10 +15,9 @@
   "scripts": {
     "clean": "rimraf dist *.tsbuildinfo",
     "compile": "tsc -b",
-    "prepare": "yarn clean && yarn compile",
+    "prepare": "yarn compile",
     "test": "tsc -b && bash scripts/test.sh",
-    "test:watch": "fgbg 'bash scripts/test.sh --watch' 'tsc -b --watch' --",
-    "version": "node ../../scripts/bump-changelog.js"
+    "test:watch": "fgbg 'bash scripts/test.sh --watch' 'tsc -b --watch' --"
   },
   "devDependencies": {
     "@nomicfoundation/hardhat-ethers": "^3.0.5",

scripts/release/format-changelog.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+
+// Adjusts the format of the changelog that changesets generates.
+
+const { readFileSync, writeFileSync } = require('fs');
+const { join } = require('path');
+
+function formatChangelog(dir) {
+  const changelogPath = join(dir, 'CHANGELOG.md');
+
+  const changelog = readFileSync(changelogPath, 'utf8');
+
+  // Groups:
+  //  - 1: Pull Request Number and URL
+  //  - 2: Changeset entry
+  const RELEASE_LINE_REGEX = /^- (\[#.*?\]\(.*?\))?.*?! - (.*)$/gm;
+
+  // Captures X.Y.Z or X.Y.Z-rc.W
+  const VERSION_TITLE_REGEX = /^## (\d+\.\d+\.\d+(-rc\.\d+)?)$/gm;
+
+  const formatted = changelog
+    // Remove titles
+    .replace(/^### Major Changes\n\n/gm, '')
+    .replace(/^### Minor Changes\n\n/gm, '')
+    .replace(/^### Patch Changes\n\n/gm, '')
+    // Remove extra whitespace between items
+    .replace(/^(- \[.*\n)\n(?=-)/gm, '$1')
+    // Format each release line
+    .replace(RELEASE_LINE_REGEX, (_, pr, entry) => (pr ? `- ${entry} (${pr})` : `- ${entry}`))
+    // Add date to new version
+    .replace(VERSION_TITLE_REGEX, `\n## $1 (${new Date().toISOString().split('T')[0]})`);
+
+  writeFileSync(changelogPath, formatted);
+}
+
+const packageFolders = ['core', 'plugin-hardhat'];
+for (const folder of packageFolders) {
+  console.log(`Formatting changelog for ${folder}...`);
+  const packageDir = join('./packages', folder);
+  formatChangelog(packageDir);
+}

scripts/release/publish.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+yarn install --frozen-lockfile
+changeset publish
+git push --follow-tags

scripts/release/version.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+changeset version
+
+node scripts/release/format-changelog.js