DEVELOPING.md - third_party/github/bazel-contrib/rules_nodejs - Git at Google

 # For Developers

 We strongly encourage you to review the project's scope described in the `README.md` file before working on new features. For large changes, consider writing a design document using [this template](https://goo.gl/YCQttR).

 ## Testing locally

 This repository contains nested workspaces which are tested with the bazel-in-bazel bazel_integration_test rule. The integration tests must be run in series as they use up too many resources when run in parallel.

 `bazel test ...` includes all these integration tests so if you want to run all tests except the integration tests you can use `bazel test ... --test_tag_filters=-e2e,-examples`. A shortcut for this is `yarn test`.

 When running the e2e tests, it is recommended to tune the memory usage of Bazel locally. This can be done with `bazel --host_jvm_args=-Xms256m --host_jvm_args=-Xmx1280m test ... --test_tag_filters=e2e --local_ram_resources=792 --test_arg=--local_ram_resources=13288`. A shortcut for this is `yarn test_e2e`.

 Similarly, for test examples run  `bazel --host_jvm_args=-Xms256m --host_jvm_args=-Xmx1280m test ... --test_tag_filters=examples --local_ram_resources=792 --test_arg=--local_ram_resources=13288`. A shortcut for this is `yarn test_examples`.

 To test all targets locally in the main workspace and in all nested workspaces run:

 ```
 yarn test_all
 ```

 To do a full clean run:

 ```
 yarn clean_all
 ```

 ## Debugging

 See `Debugging` section under `/docs/index.md`.

 ## Releasing

 Start from a clean checkout at master/HEAD.

 Note: if you are using a new clone, you'll need to configure `git-clang-format` to be able to commit the release:

 1. `git config clangFormat.binary node_modules/.bin/clang-format`
 1. `git config clangFormat.style file`

 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 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 [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'`
 1. `git push upstream && git push upstream --tags`
 1. (Manual for now): go to the [releases] page, edit the release with rough changelog (especially note any breaking changes!) and upload the release artifact from `rules_nodejs-[version].tar.gz`. Also copy the release notes from CHANGELOG.md
 1. Announce the release on Angular slack in `#tools-abc-discuss`

 [releases]: https://github.com/bazelbuild/rules_nodejs/releases
	# For Developers

	We strongly encourage you to review the project's scope described in the `README.md` file before working on new features. For large changes, consider writing a design document using [this template](https://goo.gl/YCQttR).

	## Testing locally

	This repository contains nested workspaces which are tested with the bazel-in-bazel bazel_integration_test rule. The integration tests must be run in series as they use up too many resources when run in parallel.

	`bazel test ...` includes all these integration tests so if you want to run all tests except the integration tests you can use `bazel test ... --test_tag_filters=-e2e,-examples`. A shortcut for this is `yarn test`.

	When running the e2e tests, it is recommended to tune the memory usage of Bazel locally. This can be done with `bazel --host_jvm_args=-Xms256m --host_jvm_args=-Xmx1280m test ... --test_tag_filters=e2e --local_ram_resources=792 --test_arg=--local_ram_resources=13288`. A shortcut for this is `yarn test_e2e`.

	Similarly, for test examples run `bazel --host_jvm_args=-Xms256m --host_jvm_args=-Xmx1280m test ... --test_tag_filters=examples --local_ram_resources=792 --test_arg=--local_ram_resources=13288`. A shortcut for this is `yarn test_examples`.

	To test all targets locally in the main workspace and in all nested workspaces run:

	```
	yarn test_all
	```

	To do a full clean run:

	```
	yarn clean_all
	```

	## Debugging

	See `Debugging` section under `/docs/index.md`.

	## Releasing

	Start from a clean checkout at master/HEAD.

	Note: if you are using a new clone, you'll need to configure `git-clang-format` to be able to commit the release:

	1. `git config clangFormat.binary node_modules/.bin/clang-format`
	1. `git config clangFormat.style file`

	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 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 [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'`
	1. `git push upstream && git push upstream --tags`
	1. (Manual for now): go to the [releases] page, edit the release with rough changelog (especially note any breaking changes!) and upload the release artifact from `rules_nodejs-[version].tar.gz`. Also copy the release notes from CHANGELOG.md
	1. Announce the release on Angular slack in `#tools-abc-discuss`

	[releases]: https://github.com/bazelbuild/rules_nodejs/releases