Skip to content

Commit ff0211a

Browse files
authored
Merge pull request #28 from photon-hq/ci/cut-release-oidc
docs(release): document npm Trusted Publishing prerequisites
2 parents f7bbd15 + 0d1f89a commit ff0211a

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

.github/workflows/release.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ on:
1919
description: "Run without publishing"
2020
default: false
2121

22+
# npm OIDC Trusted Publishing prerequisites (so future maintainers don't relearn this):
23+
# 1. A trusted publisher must be configured on npmjs.com for @photon-ai/cli with the
24+
# GitHub org `photon-hq`, repo `cli`, the CALLER workflow filename `release.yaml`
25+
# (npm validates the caller, not buildspace's reusable workflow), no environment,
26+
# and "Allow npm publish" enabled.
27+
# 2. `use-oidc: true` + `id-token: write` below.
28+
# 3. buildspace's publish-npm action upgrades npm to >= 11.5.1 (Node 20 ships npm 10,
29+
# which can't authenticate tokenlessly).
30+
2231
jobs:
2332
release:
2433
uses: photon-hq/buildspace/.github/workflows/typescript-service-release.yaml@main

0 commit comments

Comments
 (0)