@metanorma/mirror 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +8 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -121,12 +121,19 @@ Every node shares the shape `{ type, attrs?, content?, marks?, text? }`. Node ty
121
121
  ```bash
122
122
  npm install
123
123
  npm run build # vite build → dist + .d.ts via vite-plugin-dts
124
+ npm run lint # eslint
124
125
  npm test # vitest unit tests
125
126
  npm run test:e2e # puppeteer e2e
126
127
  npm run test:all # both suites
127
128
  ```
128
129
 
129
- Requires **Node.js 20+**. See [CONTRIBUTING.md](./CONTRIBUTING.md) for release flow and conventions.
130
+ Requires **Node.js 20+**.
131
+
132
+ ### Releases
133
+
134
+ Releases are automated through `.github/workflows/release.yml`. A `v*` tag push, or a `workflow_dispatch` run with a `version` input, runs `npm publish --provenance --access public --tag <dist-tag>` and creates a GitHub release. The dist-tag is derived from the version (`0.1.0` → `latest`, `0.1.0-beta.1` → `beta`, `0.9.0-rc.2` → `rc`).
135
+
136
+ Publishing uses npm's [Trusted Publisher](https://docs.npmjs.com/generating-provenance-statements) (OIDC) — no `NPM_TOKEN` secret is required. The npm package lists this repository's `release.yml` workflow as a Trusted Publisher, and the workflow carries `permissions.id-token: write`, which is what npm's OIDC exchange needs.
130
137
 
131
138
  ## License
132
139
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metanorma/mirror",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "TypeScript library and Vue components for the Metanorma Mirror document format",
5
5
  "type": "module",
6
6
  "license": "BSD-3-Clause",