Skip to content

Commit 80df0c5

Browse files
committed
chore: Add prerelease command
1 parent ac4deb0 commit 80df0c5

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

docs/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ npm run verify:all -- --network <your network name> # e.g. arbitrum
150150
This script automatically reads all deployed contract addresses and their constructor arguments from the deployment artifacts and verifies them on the relevant block explorer.
151151
152152
153-
### Formatting
153+
### Format
154154
155155
Format a specific file or files in a directory:
156156
```
@@ -189,3 +189,17 @@ To render only storage diagrams:
189189
```
190190
npm run storage-to-diagrams
191191
```
192+
193+
### Release
194+
195+
- **Final releases** are automated using [Release Please](https://github.com/googleapis/release-please). Major, minor, and patch versions should be published through the corresponding GitHub Actions workflows.
196+
- **Prereleases** (`vX.Y.Z-rc.*`) should be created manually using:
197+
```
198+
npm run prerelease
199+
```
200+
This command will:
201+
- Bump the RC version in `package.json` and `package-lock.json` files.
202+
- Create a new commit with the version bump.
203+
- Generate the corresponding Git tag.
204+
205+
There is no need to create a full GitHub release for prerelease versions, a Git tag is sufficient.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
"sol-to-uml": "npx zx scripts/tools/sol-to-uml.mjs",
2525
"puml-to-links": "npx zx scripts/tools/puml-to-links.mjs",
2626
"storage-to-diagrams": "bash scripts/tools/storage-to-diagrams.sh",
27-
"doc": "npx hardhat docgen"
27+
"doc": "npx hardhat docgen",
28+
"prerelease": "npm version prerelease --preid=rc -m 'chore: v%s'"
2829
},
2930
"files": [
3031
"/abis",

0 commit comments

Comments
 (0)