modelpact 2.0.2 → 2.0.4
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.
- package/README.md +18 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -234,9 +234,16 @@ const provider = name === null ? null : PROVIDERS[name];
|
|
|
234
234
|
**Versioned, and released by machine.** Semantic versioning from conventional
|
|
235
235
|
commits: [release-please](https://github.com/googleapis/release-please) opens
|
|
236
236
|
the release PR, [`CHANGELOG.md`](CHANGELOG.md) is written from the history, and
|
|
237
|
-
the tagged tree is what `npm publish` builds
|
|
238
|
-
|
|
239
|
-
|
|
237
|
+
the tagged tree is what `npm publish` builds. A `!` in a commit is a major, and
|
|
238
|
+
2.0 was one — four public names changed for the better, and the changelog says
|
|
239
|
+
which.
|
|
240
|
+
|
|
241
|
+
**Published without a key.** npm trusts this repository and this workflow file
|
|
242
|
+
by name, so the release job signs in with its own OIDC identity and a
|
|
243
|
+
credential that lives for one publish. There is no long-lived token to leak,
|
|
244
|
+
and every version carries a
|
|
245
|
+
[provenance attestation](https://docs.npmjs.com/generating-provenance-statements)
|
|
246
|
+
saying which commit and which workflow built it.
|
|
240
247
|
|
|
241
248
|
**Small on purpose.** ESM only, zero runtime dependencies, and the whole entry
|
|
242
249
|
is 13.6 kB minified, 4.9 kB gzipped, before tree-shaking takes the providers
|
|
@@ -353,19 +360,15 @@ it. Vitest deliberately misses it — `include` there is `*.test.ts`.
|
|
|
353
360
|
|
|
354
361
|
## Contributing
|
|
355
362
|
|
|
356
|
-
|
|
357
|
-
`
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
npm ci
|
|
362
|
-
npm run typecheck && npm run lint && npm run format:check && npm test
|
|
363
|
-
npm run test:e2e # Chromium; the demo server starts itself
|
|
364
|
-
npm run external && npm run external:orchestrator && npm run external:agent
|
|
365
|
-
```
|
|
363
|
+
A backend is the most useful thing to bring: four answers, `createProvider`,
|
|
364
|
+
and `describeContract` green. [`CONTRIBUTING.md`](CONTRIBUTING.md) has the
|
|
365
|
+
setup, every check CI runs and how to run it first, the commit convention, the
|
|
366
|
+
two rules the conformance suite will otherwise find for you, and where a change
|
|
367
|
+
belongs among the three storeys.
|
|
366
368
|
|
|
367
|
-
|
|
368
|
-
|
|
369
|
+
[`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) is the short version of be decent.
|
|
370
|
+
[`SECURITY.md`](SECURITY.md) is how to report a vulnerability privately, and
|
|
371
|
+
what this package does and does not do with what a model says.
|
|
369
372
|
|
|
370
373
|
## License
|
|
371
374
|
|