From dbb117b613b1ac646780f11cb11dda424e1c873f Mon Sep 17 00:00:00 2001 From: Haseeb Ahmad Date: Wed, 24 Jun 2026 12:31:13 +0200 Subject: [PATCH] CLOUDPLAT-3162: add npm OIDC publish workflow https://mapbox.atlassian.net/browse/CLOUDPLAT-3162 --- .github/workflows/npm-release.yml | 15 +++++++++++++++ CONTRIBUTING.md | 24 ++++++++++++++++++++++++ package.json | 7 +++++-- 3 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/npm-release.yml create mode 100644 CONTRIBUTING.md diff --git a/.github/workflows/npm-release.yml b/.github/workflows/npm-release.yml new file mode 100644 index 0000000..ba2ea44 --- /dev/null +++ b/.github/workflows/npm-release.yml @@ -0,0 +1,15 @@ +name: NPM release + +on: + workflow_dispatch: + +jobs: + npm-release: + uses: mapbox/gha-public/.github/workflows/workflow-npm-oidc-publish.yml@main + permissions: + id-token: write + contents: write + with: + create-github-release: true + environment: npm-release + run-tests: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6e5d9c0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing to pixelmatch + +## Development + +```bash +npm ci +npm test +``` + +## Releasing a new version + +Releases are published to npm via GitHub Actions. + +### Steps + +1. **Bump the version** in `package.json` (follow [semver](https://semver.org)) +2. **Update `CHANGELOG.md`** with a summary of what changed +3. **Open a PR**, get it reviewed and merged to `main` +4. **Trigger the release** from the [Actions tab](../../actions/workflows/npm-release.yml): + - Select **NPM release** → **Run workflow** → run from `main` + +The workflow will publish to npm and create a GitHub release with auto-generated notes. + +> **Note:** Only Mapbox maintainers with write access to this repository can trigger the release workflow. External contributors can open and contribute to PRs, but releases are always cut by the owning team. diff --git a/package.json b/package.json index 211ab79..5574ef6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "pixelmatch", - "version": "7.2.0", + "version": "7.2.1", "type": "module", "description": "The smallest and fastest pixel-level image comparison library.", "main": "index.js", @@ -38,5 +38,8 @@ "bugs": { "url": "https://github.com/mapbox/pixelmatch/issues" }, - "homepage": "https://github.com/mapbox/pixelmatch#readme" + "homepage": "https://github.com/mapbox/pixelmatch#readme", + "publishConfig": { + "access": "public" + } }