ci: update the version packages (#488)

* Version Packages * Add npmrc & remove root from manually updating * Add npmrc & remove root from manually updating * update nx version * Fix the publish command * Add command to update the lockfile * Specify the shell * Check current branch * Specify the shell * Check the current branch * Fix syntax err * Check the current branch * Check the current branch * Check the current branch * Check the current branch * Update the lock file via ci * Update the readme file * Move the step that updates the lock file to the version.yml workflow * Move the step that updates the lock file to the version-snapshot.yml workflow --------- Co-authored-by: svc-gh-is-01 <[email protected]> Co-authored-by: tirumerla <[email protected]> Co-authored-by: collins-w <[email protected]>
OpenZeppelin · Jul 23, 2024 · 4aaf7b8 · 4aaf7b8
1 parent 19cd7a9
commit 4aaf7b8
Show file tree

Hide file tree

Showing 88 changed files with 626 additions and 1,055 deletions.
diff --git a/.changeset/strange-squids-turn.md b/.changeset/strange-squids-turn.md
diff --git a/.github/actions/prepare/action.yml b/.github/actions/prepare/action.yml
@@ -13,11 +13,13 @@ runs:
       with:
         version: 9
         run_install: false
+
     - name: Use node@20
       uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
       with:
         node-version: 20.11.1
         cache: 'pnpm'
+
     - name: Install dependencies
       run: |
         pnpm install-deps

diff --git a/.github/workflows/version-snapshot.yml b/.github/workflows/version-snapshot.yml
@@ -43,3 +43,12 @@ jobs:
           title: "ci: update the version packages"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Update the lock file
+        run: pnpm install --lockfile-only
+        shell: bash
+
+      - name: Commit lock file
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "chore: update lock file"
diff --git a/.github/workflows/version.yml b/.github/workflows/version.yml
@@ -43,3 +43,12 @@ jobs:
           title: "ci: update the version packages"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Update the lock file
+        run: pnpm install --lockfile-only
+        shell: bash
+
+      - name: Commit lock file
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "chore: update lock file"
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1,5 @@
+engine-strict=true                  # https://pnpm.io/npmrc#engine-strict
+auto-install-peers=true             # https://pnpm.io/npmrc#auto-install-peers
+link-workspace-packages=true        # https://pnpm.io/npmrc#link-workspace-packages
+prefer-workspace-packages=true      # https://pnpm.io/npmrc#prefer-workspace-packages
+include-workspace-root=true         # https://pnpm.io/npmrc#include-workspace-root
diff --git a/README.md b/README.md
@@ -59,30 +59,6 @@ DEFENDER_RELAY_SIGNER_POOL_CLIENT_ID=
 
 ---
 
-### CI/CD
-
-- Run `npx changeset` to select specific packages to bump ( use up & down arrows to navigate, space to select specific packages). This will create a new changeset file in `./changesets` folder. Update changelog in changeset file if needed using `feat:`, `fix:`, `docs:`, `chore:` or `refactor:` prefixes.
-- Create a PR with changeset file.
-- After the PR is approved & merged. Changeset bot will automatically create a PR deleting the changeset file and bumping the package version & updates changelog. This PR will not automatically update the package version/dependencies in `package.json` file. You will have to manually push the change to this PR updating package version/version of `@openzeppelin/defender-sdk-base-client` in `package.json` file and run `pnpm i --ignore-scripts --prefer-offline` to make sure pnpm lock file is updated.
-- After the PR is approved & merged make sure to run build & tests using `pnpm nx-build-skip-cache` && `pnpm nx-test-skip-cache`.
-- After the tests passes run `npx changeset publish` this publishes the packages to npm. Or use the workflow dispatch(publish.yml) to trigger the publish using the CI.
-- Finally push tags ( make sure you are signing tags before pushing ) to git `git push --follow-tags`. (This step is not needed if publishing using the CI as the the tags will be pushed automatically).
-
-## Snapshot Release
-
-- Checkout from the main branch(with changeset file) to a branch prefixed by `snapshot`.
-- Raise a PR to target the snapshot branch.
-- Merge the PR to the snapshot branch.
-- After the PR is merged, another PR will be created that removes the changeset file and bumps the packages versions. Manually push a change to this PR updating package version of `@openzeppelin/defender-sdk-base-client` in `package.json` file and run `pnpm i --ignore-scripts --prefer-offline` to make sure pnpm lock file is updated.
-- After the above PR has been merged, manually trigger the snapshot workflow, `publish-snapshot.yml`, to release the snapshot.
-
-<!-- TODO: once we have CI/CD steps fully defined we should validate this is accurate -->
-
-- We use github actions for CI/CD. See [workflows](.github/workflows) for more info.
-  - `ci.yml` - runs on every push to any branch --> runs tests.
-
----
-
 ### Determinstic Builds & Secure Publishes
 
 - We use [slsa framework](https://slsa.dev/) _pronounced "salsa"_ for reproducible builds & secure pushes. Verification is done using [provenance](https://slsa.dev/provenance/v1)
diff --git a/examples/create-action/CHANGELOG.md b/examples/create-action/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @openzeppelin/defender-sdk-example-create-action
 
+## 1.14.2
+
+### Patch Changes
+
+- 19cd7a9: feat: Add relayers usage limiting
+  feat: Add an example contract call
+- Updated dependencies [19cd7a9]
+  - @openzeppelin/defender-sdk@1.14.2
+
 ## 1.14.1
 
 ### Patch Changes

diff --git a/examples/create-action/package.json b/examples/create-action/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-sdk-example-create-action",
-  "version": "1.14.1",
+  "version": "1.14.2",
   "private": true,
   "main": "index.js",
   "author": "Nami Shah <[email protected]>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.14.1",
+    "@openzeppelin/defender-sdk": "1.14.2",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-batch-proposal/CHANGELOG.md b/examples/create-batch-proposal/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @openzeppelin/defender-sdk-example-create-batch-proposal
 
+## 1.14.2
+
+### Patch Changes
+
+- 19cd7a9: feat: Add relayers usage limiting
+  feat: Add an example contract call
+- Updated dependencies [19cd7a9]
+  - @openzeppelin/defender-sdk@1.14.2
+
 ## 1.14.1
 
 ### Patch Changes

diff --git a/examples/create-batch-proposal/package.json b/examples/create-batch-proposal/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-sdk-example-create-batch-proposal",
-  "version": "1.14.1",
+  "version": "1.14.2",
   "private": true,
   "main": "index.js",
   "author": "Nami Shah <[email protected]>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.14.1",
+    "@openzeppelin/defender-sdk": "1.14.2",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-forked-network/CHANGELOG.md b/examples/create-forked-network/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @openzeppelin/defender-sdk-example-create-forked-network
 
+## 1.14.2
+
+### Patch Changes
+
+- 19cd7a9: feat: Add relayers usage limiting
+  feat: Add an example contract call
+- Updated dependencies [19cd7a9]
+  - @openzeppelin/defender-sdk@1.14.2
+
 ## 1.14.1
 
 ### Patch Changes

diff --git a/examples/create-forked-network/package.json b/examples/create-forked-network/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-sdk-example-create-forked-network",
-  "version": "1.14.1",
+  "version": "1.14.2",
   "private": true,
   "main": "index.js",
   "author": "Zeljko Markovic <[email protected]>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.14.1",
+    "@openzeppelin/defender-sdk": "1.14.2",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-monitor/CHANGELOG.md b/examples/create-monitor/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @openzeppelin/defender-sdk-example-create-monitor
 
+## 1.1.2
+
+### Patch Changes
+
+- 19cd7a9: feat: Add relayers usage limiting
+  feat: Add an example contract call
+- Updated dependencies [19cd7a9]
+  - @openzeppelin/defender-sdk@1.14.2
+
 ## 1.1.1
 
 ### Patch Changes

diff --git a/examples/create-monitor/package.json b/examples/create-monitor/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-sdk-example-create-monitor",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "private": true,
   "main": "index.js",
   "author": "OpenZeppelin Defender <[email protected]>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.14.1",
+    "@openzeppelin/defender-sdk": "1.14.2",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-private-network/CHANGELOG.md b/examples/create-private-network/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @openzeppelin/defender-sdk-example-create-private-network
 
+## 1.14.2
+
+### Patch Changes
+
+- 19cd7a9: feat: Add relayers usage limiting
+  feat: Add an example contract call
+- Updated dependencies [19cd7a9]
+  - @openzeppelin/defender-sdk@1.14.2
+
 ## 1.14.1
 
 ### Patch Changes

diff --git a/examples/create-private-network/package.json b/examples/create-private-network/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-sdk-example-create-private-network",
-  "version": "1.14.1",
+  "version": "1.14.2",
   "private": true,
   "main": "index.js",
   "author": "Nami Shah <[email protected]>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.14.1",
+    "@openzeppelin/defender-sdk": "1.14.2",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-proposal/CHANGELOG.md b/examples/create-proposal/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @openzeppelin/defender-sdk-example-create-proposal
 
+## 1.14.2
+
+### Patch Changes
+
+- 19cd7a9: feat: Add relayers usage limiting
+  feat: Add an example contract call
+- Updated dependencies [19cd7a9]
+  - @openzeppelin/defender-sdk@1.14.2
+
 ## 1.14.1
 
 ### Patch Changes

diff --git a/examples/create-proposal/package.json b/examples/create-proposal/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/defender-sdk-example-create-proposal",
-  "version": "1.14.1",
+  "version": "1.14.2",
   "private": true,
   "main": "index.js",
   "author": "OpenZeppelin Defender <[email protected]>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.14.1",
+    "@openzeppelin/defender-sdk": "1.14.2",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-relayer-key/CHANGELOG.md b/examples/create-relayer-key/CHANGELOG.md
@@ -1,5 +1,14 @@
 # example-create-relayer-key
 
+## 1.14.2
+
+### Patch Changes
+
+- 19cd7a9: feat: Add relayers usage limiting
+  feat: Add an example contract call
+- Updated dependencies [19cd7a9]
+  - @openzeppelin/defender-sdk@1.14.2
+
 ## 1.14.1
 
 ### Patch Changes

diff --git a/examples/create-relayer-key/package.json b/examples/create-relayer-key/package.json
@@ -1,6 +1,6 @@
 {
   "name": "example-create-relayer-key",
-  "version": "1.14.1",
+  "version": "1.14.2",
   "private": true,
   "main": "index.js",
   "author": "Dan McKeon <[email protected]>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.14.1",
+    "@openzeppelin/defender-sdk": "1.14.2",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/create-relayer/CHANGELOG.md b/examples/create-relayer/CHANGELOG.md
@@ -1,5 +1,14 @@
 # example-create-relayer
 
+## 1.14.2
+
+### Patch Changes
+
+- 19cd7a9: feat: Add relayers usage limiting
+  feat: Add an example contract call
+- Updated dependencies [19cd7a9]
+  - @openzeppelin/defender-sdk@1.14.2
+
 ## 1.14.1
 
 ### Patch Changes

diff --git a/examples/create-relayer/package.json b/examples/create-relayer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "example-create-relayer",
-  "version": "1.14.1",
+  "version": "1.14.2",
   "private": true,
   "main": "index.js",
   "author": "Dan McKeon <[email protected]>",
@@ -9,7 +9,7 @@
     "start": "node index.js"
   },
   "dependencies": {
-    "@openzeppelin/defender-sdk": "1.14.1",
+    "@openzeppelin/defender-sdk": "1.14.2",
     "dotenv": "^16.3.1"
   }
 }
diff --git a/examples/custom-ethers-pkg/CHANGELOG.md b/examples/custom-ethers-pkg/CHANGELOG.md
@@ -1,5 +1,15 @@
 # @openzeppelin/defender-sdk-example-rollup
 
+## 1.14.2
+
+### Patch Changes
+
+- 19cd7a9: feat: Add relayers usage limiting
+  feat: Add an example contract call
+- Updated dependencies [19cd7a9]
+  - @openzeppelin/defender-sdk-action-client@1.14.2
+  - @openzeppelin/defender-sdk@1.14.2
+
 ## 1.14.1
 
 ### Patch Changes