sarif-to-comment 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.
- package/CHANGELOG.md +9 -0
- package/README.md +7 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# sarif-to-comment
|
|
2
2
|
|
|
3
|
+
## 0.1.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- e3a0c2a: Correct the release documentation shipped in the README.
|
|
8
|
+
|
|
9
|
+
- Provenance is described conditionally. Trusted publishing authenticates with OIDC from a private or public repository, but npm attaches a provenance attestation only when the source repository is public at publish time. Version 0.1.0 carries a verified attestation; a release from a private repository has none.
|
|
10
|
+
- Release commits are no longer said to be recorded as `gitHead`, which is absent from the registry metadata for 0.1.0. The commit is identified by the `publish.yml` run and, when present, the provenance attestation; tags remain optional.
|
|
11
|
+
|
|
3
12
|
## 0.1.0
|
|
4
13
|
|
|
5
14
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -181,7 +181,7 @@ If that comparison can't establish the old side, you may pass `oldSourceCommit`
|
|
|
181
181
|
- The durability steps (write, flush, then send) are ordered for crash safety, but that has not been tested against power loss.
|
|
182
182
|
- GitHub Enterprise Server and GitHub App installation tokens are not supported.
|
|
183
183
|
- There is no review maintenance, re-review or synchronisation back to SARIF.
|
|
184
|
-
-
|
|
184
|
+
- npm attaches a provenance attestation only when the source repository is public at publish time. A release published while the repository is private has no provenance attestation (see [Releasing](#releasing)).
|
|
185
185
|
|
|
186
186
|
## Development
|
|
187
187
|
|
|
@@ -242,7 +242,11 @@ Changesets pre mode (prereleases) is not part of this release path.
|
|
|
242
242
|
|
|
243
243
|
That commit changes `package.json`, so the workflow runs with the fixed code and publishes the new version. The version that failed stays unpublished; its changelog entry remains as history.
|
|
244
244
|
|
|
245
|
-
The workflow publishes but
|
|
245
|
+
**Recording the release commit.** The workflow publishes the verified tarball but doesn't create git tags, and npm's registry metadata for 0.1.0 records no `gitHead`. Do not assume that field identifies a tarball release. The commit is identified in two places:
|
|
246
|
+
- by the successful `publish.yml` workflow run for that commit on `main`;
|
|
247
|
+
- when the repository is public at publish time, by the version's npm provenance attestation, which names the source repository, workflow and commit.
|
|
248
|
+
|
|
249
|
+
Maintainers who want tags can run `pnpm changeset git-tag` locally on that commit and push the tags.
|
|
246
250
|
|
|
247
251
|
**First release.** The release history starts from npm's pre-existing `0.0.0`, the bootstrap baseline for this package. The initial `minor` changeset versions that baseline to **0.1.0**, with the first changelog entry, and 0.1.0 is the first version this workflow publishes. Later releases follow the same steps from whatever version `package.json` then holds.
|
|
248
252
|
|
|
@@ -259,4 +263,4 @@ On the package's **Settings → Trusted publishing** page, add a GitHub Actions
|
|
|
259
263
|
|
|
260
264
|
npm requires `repository.url` in `package.json` to match this repository exactly. It is `git+https://github.com/mike-north/sarif-to-comment.git`. Once a trusted release has succeeded, npm recommends setting **Publishing access** to *Require two-factor authentication and disallow tokens*.
|
|
261
265
|
|
|
262
|
-
**Provenance.** npm attaches provenance automatically only when the source repository is public.
|
|
266
|
+
**Provenance.** Trusted publishing authenticates with OIDC from a private or public repository alike. npm attaches a provenance attestation automatically only when the source repository is public at publish time; a release from a private repository has no provenance attestation. That limitation comes from npm, not from this workflow, and the workflow never changes repository visibility. Version 0.1.0 was published from the repository while it was public, and its npm provenance attestation verifies, naming commit `3797ca6efe2156d4c952fad7fed10b569f1dcbbb` and `.github/workflows/publish.yml`. The workflow deliberately does not pass `--provenance`, which fails for a private repository; npm adds provenance on its own whenever the repository is public.
|
package/package.json
CHANGED