Skip to content

Commit d45b6fa

Browse files
author
settings-as-code-release
committed
docs(library): describe only the install path this repository delivers
The package is not published yet and the build branch carries no lib/pkg/, so the install and versioning sections now say the library is built here with bun run build:lib and that npm and packaged-branch installation arrive with the publishing change. The API-by-group content is unchanged.
1 parent 68f9e0a commit d45b6fa

3 files changed

Lines changed: 7 additions & 19 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The [getting started guide](docs/start/getting-started.md) walks the same steps
6161

6262
## Library
6363

64-
The same engine is the npm package `@vivswan/github-settings-as-code` (ESM, Node 22.14 or newer): validate, merge, check, and apply from your own code. Install it with `npm install @vivswan/github-settings-as-code` or `bun add @vivswan/github-settings-as-code`; the [library reference](docs/reference/library.md) has the API by group and the `@next` pre-release channel.
64+
The same engine is the npm package `@vivswan/github-settings-as-code` (ESM, Node 22.14 or newer): validate, merge, check, and apply from your own code. It is built from this repository with `bun run build:lib`; the [library reference](docs/reference/library.md) has the API by group.
6565

6666
## Docs
6767

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The documentation for GitHub Settings as Code, in five groups. Start here if the
4343
- [The undeclared policy](reference/undeclared-policy.md): the `_undeclared` knob on the list sections, per-section defaults, the milestone-deletion caveat, and how the policy layers in `mode: merge`.
4444
- [Forward compatibility](reference/forward-compatibility.md): where payloads pass through verbatim and which sections are deliberately closed.
4545
- [Secrets and vaults](reference/secrets-and-vaults.md): the `$NAME` references secret fields take, wiring them from GitHub Secrets or a vault action, and what check mode can and cannot verify.
46-
- [Library](reference/library.md): the npm package `@vivswan/github-settings-as-code`, its install lines, the API by group with one example each, and how its version tracks the action's.
46+
- [Library](reference/library.md): the npm package `@vivswan/github-settings-as-code`, how it is built, the API by group with one example each, and how its version tracks the action's.
4747

4848
## operate: day-to-day operation
4949

‎docs/reference/library.md‎

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,14 @@ The engine behind the action is also an npm package, `@vivswan/github-settings-a
88

99
## Install
1010

11-
```bash
12-
npm install @vivswan/github-settings-as-code
13-
bun add @vivswan/github-settings-as-code
14-
```
15-
16-
Pre-releases ride the `next` dist-tag; until the first stable release only `@next` exists:
11+
The package is built from this repository:
1712

1813
```bash
19-
npm install @vivswan/github-settings-as-code@next
14+
bun install
15+
bun run build:lib
2016
```
2117

22-
A packaged commit on the `build` branch that carries `lib/pkg/` installs straight from GitHub (no registry, no build step on your side):
23-
24-
```bash
25-
npm install github:Vivswan/github-settings-as-code#<packaged sha>
26-
```
18+
That writes `lib/pkg/index.js` and `lib/pkg/index.d.ts`, the files the manifest's `exports` point at. Installing from npm or from a packaged commit of the `build` branch arrives with the publishing change.
2719

2820
The package exports three paths: the entry (`.`), the committed settings.yml JSON Schema (`./settings.schema.json`), and its own manifest (`./package.json`).
2921

@@ -153,11 +145,7 @@ console.log(exitCode, collected.outputs.result, collected.lines.map((entry) => e
153145

154146
## Versioning
155147

156-
The package and the action share one version, the one in `.release-please-manifest.json`, so a settings file that validates on the library validates on the action of the same version.
157-
158-
- Every green push to `main` publishes a pre-release under the `next` dist-tag: the next patch version, then `-main.<run>.<sha7>` (the workflow run number and the short source commit).
159-
- A release publishes the stable version and moves `latest` to it.
160-
- The `github:Vivswan/github-settings-as-code#<packaged sha>` form installs a packaged commit of the `build` branch, which carries `lib/pkg/` and `lib/index.js` built from its source commit.
148+
The package and the action share one version, the one in `.release-please-manifest.json` (release-please rewrites `package.json` from it), so a settings file that validates on the library validates on the action of the same version.
161149

162150
## One-time publishing setup
163151

0 commit comments

Comments
 (0)