Skip to content

Commit

Permalink
docs: update release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
gregmagolan committed Jan 24, 2020
1 parent 4abed91 commit 23d3baf
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ Note: if you are using a new clone, you'll need to configure `git-clang-format`

Googlers: you should npm login using the go/npm-publish service: `$ npm login --registry https://wombat-dressing-room.appspot.com`

Check if there are any breaking changes since the last tag - if so, this will be a minor, if not it's a patch.
(This may not sound like semver, but since our major version is a zero, the rule is that minors are breaking changes and patches are new features.)
Check if there are any breaking changes since the last tag - if so, this will be a major. Check if there were new features added since the last tag - if so, this will be a minor.

1. Re-generate the API docs: `yarn stardoc`
1. `git add docs/` (in case new files were created)
1. `git commit -a -m 'docs: update docs for release'`
1. `npm version minor` (replace `minor` with `patch` if no breaking changes)
1. `npm version [major|minor|patch]` (`major` if there are breaking changes, `minor` if there are new features, otherwise `patch`)
1. Manually update the CHANGELOG.md based on the commits since the last release. Look for breaking changes that weren't documented.
1. If publishing from inside Google, set NPM_REGISTRY="--registry https://wombat-dressing-room.appspot.com" in your environment
1. Build npm packages and publish them: `./scripts/publish_release.sh`
1. Run `./scripts/update_nested_lock_files.sh` to update the lock files in all nested workspaces to new release
1. `git commit -a -m 'chore: update lock files for release'`
Expand Down
2 changes: 1 addition & 1 deletion scripts/on-release.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ for (const f of ['docs/install.md', 'packages/create/index.js']) {
`download/${version}/rules_nodejs-${version}.tar.gz`, f);
shell.sed('-i', 'sha256 = \"[0-9a-f]+\"', `sha256 = "${sha256}"`, f);
}
shell.cp(artifact, `rules_nodejs-${version}.tar.gz`);
shell.cp('-f', artifact, `rules_nodejs-${version}.tar.gz`);

/**
* Returns an array of all WORKSPACE the files under a directory.
Expand Down
2 changes: 1 addition & 1 deletion scripts/publish_release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ readonly PKG_NPM_LABELS=`$BAZEL query --output=label 'kind("pkg_npm rule", //pac
$BAZEL build --config=release $PKG_NPM_LABELS
# publish one package at a time to make it easier to spot any errors or warnings
for pkg in $PKG_NPM_LABELS ; do
$BAZEL run --config=release -- ${pkg}.${NPM_COMMAND} --access public --tag latest --registry https://wombat-dressing-room.appspot.com
$BAZEL run --config=release -- ${pkg}.${NPM_COMMAND} --access public --tag latest ${NPM_REGISTRY:-}
done

0 comments on commit 23d3baf

Please sign in to comment.