Include README in @bazel/karma package
This way the docs are visibile on npmjs.com
Closes #427
PiperOrigin-RevId: 235021720
diff --git a/DEVELOPING.md b/DEVELOPING.md
index 81bc6e1..c5b36dd 100644
--- a/DEVELOPING.md
+++ b/DEVELOPING.md
@@ -56,7 +56,7 @@
(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).
-1. Re-generate the API docs: `yarn skydoc && (cd internal/karma; yarn skydoc)`
+1. Re-generate the API docs: `yarn skydoc`
1. May be necessary if Go code has changed though probably it was already necessary to run this to keep CI green: `bazel run :gazelle`
1. If we depend on a newer rules_nodejs, update the `check_rules_nodejs_version` in `ts_repositories.bzl`
1. `git commit -a -m 'Update docs for release'`
diff --git a/README.md b/README.md
index b404de8..3819e0a 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@
{
...
"devDependencies": {
- "@bazel/typescript": "0.25.0",
+ "@bazel/typescript": "0.25.1",
...
},
...
diff --git a/WORKSPACE b/WORKSPACE
index 27b2098..b2e86ba 100644
--- a/WORKSPACE
+++ b/WORKSPACE
@@ -77,7 +77,7 @@
# Test that check_rules_typescript_version works as expected
load("//:defs.bzl", "check_rules_typescript_version")
-check_rules_typescript_version(version_string = "0.25.0")
+check_rules_typescript_version(version_string = "0.25.1")
# Dependencies for generating documentation
load("@io_bazel_rules_sass//sass:sass_repositories.bzl", "sass_repositories")
diff --git a/internal/karma/.gitignore b/internal/karma/.gitignore
deleted file mode 100644
index bae2b58..0000000
--- a/internal/karma/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-# This file is generated during the build
-README.md
diff --git a/internal/karma/BUILD.bazel b/internal/karma/BUILD.bazel
index f00ec1b..54f69ed 100644
--- a/internal/karma/BUILD.bazel
+++ b/internal/karma/BUILD.bazel
@@ -65,6 +65,16 @@
cmd = "cp $< $@",
)
+# Ugly genrule depending on local linux environment to build the README out of skylark doc generation.
+# Only referenced when we do a release.
+# TODO: This ought to be possible with stardoc alone. Need to coordinate with Chris Parsons.
+genrule(
+ name = "generate_README",
+ srcs = ["//docs", "//docs:install.md"],
+ outs = ["README.md"],
+ cmd = "unzip -o -d docs $(location //docs:docs) && cat docs/install.md docs/*_web_test.md | sed 's/^##/\\\n##/' > $@",
+)
+
npm_package(
name = "npm_package",
srcs = [
@@ -88,6 +98,7 @@
deps = [
":bazel_karma",
":license_copy",
+ ":generate_README"
],
)
diff --git a/internal/karma/docs/BUILD.bazel b/internal/karma/docs/BUILD.bazel
index dc0a3bc..ff0476c 100644
--- a/internal/karma/docs/BUILD.bazel
+++ b/internal/karma/docs/BUILD.bazel
@@ -1,5 +1,5 @@
load("@io_bazel_skydoc//skylark:skylark.bzl", "skylark_doc")
-
+exports_files(["install.md"])
skylark_doc(
name = "docs",
srcs = [
@@ -7,4 +7,5 @@
"//:ts_web_test.bzl",
],
format = "markdown",
+ visibility = ["//:__subpackages__"],
)
diff --git a/internal/karma/package.json b/internal/karma/package.json
index e714d26..5f71978 100644
--- a/internal/karma/package.json
+++ b/internal/karma/package.json
@@ -43,8 +43,5 @@
"compatVersion": "0.0.0-COMPAT_VERSION",
"rootPath": "."
}
- },
- "scripts": {
- "skydoc": "bazel build --symlink_prefix=bazel- //docs && unzip -o -d docs bazel-bin/docs/docs-skydoc.zip && cat docs/install.md docs/*_web_test.md | sed 's/^##/\\\n##/' > README.md"
}
}
diff --git a/package.json b/package.json
index b416f5f..d82e3f2 100644
--- a/package.json
+++ b/package.json
@@ -3,7 +3,7 @@
"description": "TypeScript rules for Bazel",
"homepage": "https://github.com/bazelbuild/rules_typescript",
"license": "Apache-2.0",
- "version": "0.25.0",
+ "version": "0.25.1",
"keywords": [
"typescript",
"bazel"
diff --git a/version.bzl b/version.bzl
index 570c649..f295332 100644
--- a/version.bzl
+++ b/version.bzl
@@ -17,7 +17,7 @@
load("@build_bazel_rules_nodejs//internal/common:check_version.bzl", "check_version")
-VERSION = "0.25.0"
+VERSION = "0.25.1"
# This version is the minimum version that is API compatible with this version
# of rules_typescript. This version should be updated to equal VERSION for
