Skip to content

Add permissions configuration to workflows and enable npm provenance #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgreif merged 3 commits into from
Oct 7, 2025
Merged

Add permissions configuration to workflows and enable npm provenance #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba3583e
Initial plan
Copilot Oct 7, 2025
ce32fa3
Add permissions configuration to all workflow files and provenance to…
Copilot Oct 7, 2025
0aa94b3
Add id-token permission and provenance to publish.yml workflow
Copilot Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/nodejs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ on:
pull_request:
branches: [ main ]

permissions:
contents: read

jobs:
build:

Expand Down
6 changes: 5 additions & 1 deletion .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ on:
release:
types: [created]

permissions:
contents: read
id-token: write

jobs:
publish-npm:
runs-on: ubuntu-latest
Expand All @@ -19,6 +23,6 @@ jobs:
- run: npm version ${TAG_NAME} --git-tag-version=false
env:
TAG_NAME: ${{ github.event.release.tag_name }}
- run: npm whoami; npm --ignore-scripts publish
- run: npm whoami; npm --ignore-scripts publish --provenance
Copy link

@jibrang jibrang Oct 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need to use --provenance here?

Copy link
Contributor

@dgreif dgreif Oct 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a newer feature with npm which we've turned on in most of our OSS packages. It provides hard links back to the action which built the published version, improving trust and integrity of npm packages.

Copy link

@jibrang jibrang Oct 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! Thanks for the context!

env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
6 changes: 5 additions & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ on:
description: Semver descriptor for new version ("major", "minor", or "patch")
required: true

permissions:
contents: write
id-token: write

jobs:
bump-version:
name: Bump package version
Expand Down Expand Up @@ -70,6 +74,6 @@ jobs:
- name: Build package
run: npm run build --if-present
- name: Publish
run: npm publish --access public
run: npm publish --provenance --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}