Maintenance

This page is for maintainers of CosmJS only.

How to publish to npm (Yarn 2; CosmJS 0.26+)

One-time setup

1. Login using yarn npm login --publish

For every release

2. Update CHANGELOG.md and ensure it is properly formatted (see fc676968ee). We will commit this in step 5.
3. export NEW_COSMJS_VERSION="0.26.0-alpha1"
4. Run git clean -xdf ./packages && yarn install && yarn build
5. yarn workspaces foreach exec yarn version --immediate "$NEW_COSMJS_VERSION"
6. git add . && git commit -m "Set version $NEW_COSMJS_VERSION" && git tag "v$NEW_COSMJS_VERSION"
7. Either pre-release yarn publish-next or stable release yarn publish-latest
8. git push && git push --tags

On a x86_64 machine

9. export NEW_COSMJS_VERSION="0.26.0-alpha1"
10. git fetch --all && git checkout "v$NEW_COSMJS_VERSION"
11. Run docker build -t "confio/faucet:$NEW_COSMJS_VERSION" -f packages/faucet/Dockerfile .
12. Publish faucet: docker push "confio/faucet:$NEW_COSMJS_VERSION"

How to publish to npm

One-time setup

1. Login using npm login

For every release

1. Update CHANGELOG.md (see https://github.com/cosmos/cosmjs/commit/fc676968ee295d764e213dac52cc46dd5bc6299c).
2. Run git clean -xdf && yarn install && yarn build
3. Run ./scripts/add_nonces.sh && git add packages/ && git commit -m "Add nonces"
4. Run ./node_modules/.bin/lerna publish or for pre-releases run ./node_modules/.bin/lerna publish --dist-tag next and select a pre-release version

Copy "next" version to "latest" for newly added packages

for p in [package1] [package2] [...];
  do npm dist-tag add @cosmjs/$p@$(npm view @cosmjs/$p@next version) latest;
done

Remove npm tag

When no current pre-release exists, the next tag should be deleted:

$ ./node_modules/.bin/lerna exec --no-private -- npm dist-tag rm "\$LERNA_PACKAGE_NAME" next

Upgrade yarn

1. yarn set version latest
2. Check: yarn --version
3. Ensure lockfile is up-to-date: yarn install

Update ts-proto

1. Install the new version of ts-proto using yarn
2. Download proto files

   for p in cosmwasm-stargate stargate proto-signing; do
     (cd "packages/$p" && yarn get-proto);
   done
   

3. Regenerate TS files

   for p in cosmwasm-stargate stargate proto-signing; do
     (cd "packages/$p" && yarn define-proto);
   done
   

4. Revert path issues (see https://github.com/cosmos/cosmjs/issues/656)