You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit d45b6fa
Browse filesBrowse the repository at this point in the historyBrowse files
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.
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ The [getting started guide](docs/start/getting-started.md) walks the same steps
61
61
62
62
## Library
63
63
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.
Copy file name to clipboardExpand all lines: docs/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ The documentation for GitHub Settings as Code, in five groups. Start here if the
43
43
-[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`.
44
44
-[Forward compatibility](reference/forward-compatibility.md): where payloads pass through verbatim and which sections are deliberately closed.
45
45
-[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.
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.
27
19
28
20
The package exports three paths: the entry (`.`), the committed settings.yml JSON Schema (`./settings.schema.json`), and its own manifest (`./package.json`).
29
21
@@ -153,11 +145,7 @@ console.log(exitCode, collected.outputs.result, collected.lines.map((entry) => e
153
145
154
146
## Versioning
155
147
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.
0 commit comments