From b7173b447f5b5c42a0e6cf8cfe594f752da960a7 Mon Sep 17 00:00:00 2001 From: Haseeb Ahmad Date: Thu, 18 Jun 2026 11:13:56 +0200 Subject: [PATCH 1/2] CLOUDPLAT-3162: add npm OIDC publish workflow https://mapbox.atlassian.net/browse/CLOUDPLAT-3162 --- .github/workflows/npm-release.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/workflows/npm-release.yml diff --git a/.github/workflows/npm-release.yml b/.github/workflows/npm-release.yml new file mode 100644 index 0000000..5bd342e --- /dev/null +++ b/.github/workflows/npm-release.yml @@ -0,0 +1,13 @@ +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 From fe15526278a0b8a7146fbd59aadbf09d6bc3e86d Mon Sep 17 00:00:00 2001 From: Haseeb Ahmad Date: Thu, 18 Jun 2026 12:05:54 +0200 Subject: [PATCH 2/2] CLOUDPLAT-3162: add CONTRIBUTING.md and bump version https://mapbox.atlassian.net/browse/CLOUDPLAT-3162 --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ package.json | 5 ++++- 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0950464 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing to s3scan + +## 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 `master` +4. **Trigger the release** from the [Actions tab](../../actions/workflows/npm-release.yml): + - Select **NPM release** → **Run workflow** → run from `master` + +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 a95ac7d..7886499 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@mapbox/s3scan", - "version": "3.0.0", + "version": "3.0.1", "description": "Streaming operations on S3 objects", "main": "index.js", "engines": { @@ -39,5 +39,8 @@ "eslint": "^8.52.0", "tape": "^4.6.3", "underscore": "^1.13.6" + }, + "publishConfig": { + "access": "public" } }