Skip to content

Commit

Permalink
Remove references to ref/external.
Browse files Browse the repository at this point in the history
This branch is no longer needed because `@aspect_rules_js` actually supports `local_repository()`, so `//examples/external/...` serves its purpose.
  • Loading branch information
dgp1130 committed Feb 18, 2023
1 parent f302628 commit 47cf72a
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 38 deletions.
5 changes: 0 additions & 5 deletions .bazelignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,4 @@ node_modules
dist
bazel-out

# The `ref/external` branch includes a user repository in `user/`. This ignores
# it even outside that branch so checking out from that branch doesn't break the
# main workspace in any other branch.
user

examples/external/
33 changes: 0 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -614,39 +614,6 @@ needed at run time, then a `publish_files()` macro is needed to copy them into
the NPM package, and a `BUILD.publish` file may be needed to configure their
runtime usage and provide consistency with build time usage.
### Testing publishable builds
Currently there are no automated tests of the published package or run time
builds (aside from a simple build test of the NPM package directory). To test
this manually, you need to:
1. Build the NPM package in `rules_prerender`.
* This generates `dist/bin/pkg/` which contains the contents of the NPM
package.
```shell
bazel build //:pkg.pack
```
1. Set up a separate Bazel workspace and `cd` into it.
* Easiest way to do this from scratch is:
```shell
npx @bazel/create ${NAME}
cd ${NAME}
npm install
```
1. Install the local `rules_prerender` build.
```shell
npm install --save-dev path/to/rules_prerender/workspace/dist/bin/pkg
```
1. Use `@npm//rules_prerender/...` and build some code.
Check out the
[`ref/external`](https://github.com/dgp1130/rules_prerender/tree/ref/external/)
branch which includes an in-tree user workspace which can be used to more easily
verify and debug run time execution.
### Releasing
To actually publish a release to NPM, follow these steps:
Expand Down

0 comments on commit 47cf72a

Please sign in to comment.