Skip to content

Latest commit

 

History

History
74 lines (56 loc) · 1.78 KB

MAINTAINERS.md

File metadata and controls

74 lines (56 loc) · 1.78 KB

Maintainer Hints

# Create a release branch.
now=`date -u +%Y%m%dT%H%M%S`
git checkout -b release-$now

To generate a new final release, and CHANGELOG.md files (use --conventional-prerelease instead of --conventional-graduate if you just want to generate a dev release):

# Create the final release CHANGELOGs.
yarn lerna version --no-push --conventional-graduate
# Push the branch.
git push -u origin release-$now
# Tell which packages have actual news.
scripts/have-news HEAD^ > have-news.md

Create a release PR, pasting have-news.md into the body. Then build the SDK:

# Build all package generated files.
yarn install
yarn build

Once tests pass, you can publish to NPM with the following:

# Publish to NPM. NOTE: You may have to repeat this several times if there are failures.
yarn lerna publish from-package

Merge the release PR into master. DO NOT REBASE OR SQUASH OR YOU WILL LOSE REFERENCES TO YOUR TAGS.

# Publish the released package tags.
./scripts/get-released-tags git push origin

If you want to update an NPM dist-tag for the current checked-out Agoric SDK's packages (to enable agoric install <TAG>), use:

# Use "beta" for <TAG> for example.
./scripts/npm-dist-tag.sh lerna add <TAG>

To make validators' lives easier, create a Git tag for the chain-id:

CHAIN_ID=agoricstage-8 # Change this as necessary
SDK_VERSION=$(jq -r .version package.json)
git tag -s -m "release $CHAIN_ID" $CHAIN_ID @agoric/sdk@$SDK_VERSION^{}
git push origin $CHAIN_ID

More subtlety

To get help for the command-line options that will affect these commands, use:

yarn lerna version --help
yarn lerna publish --help

Useful testing commands are:

yarn lerna version --conventional-prerelease --no-git-tag-version