From 7a1878af7b87adb1e45cf4bb026411b992c22f66 Mon Sep 17 00:00:00 2001 From: Tomasz Andrzejak Date: Tue, 12 May 2026 13:38:03 +0200 Subject: [PATCH] chore(ci): enable trusted publishing --- .github/scripts/check-npm-packages.sh | 32 ++++ .github/scripts/stage-npm-assets.sh | 15 ++ .github/workflows/npm-publish.yml | 34 ++--- .github/workflows/release-plz.yml | 10 +- LICENSE | 202 ++++++++++++++++++++++++++ README.md | 17 ++- 6 files changed, 280 insertions(+), 30 deletions(-) create mode 100755 .github/scripts/check-npm-packages.sh create mode 100755 .github/scripts/stage-npm-assets.sh create mode 100644 LICENSE diff --git a/.github/scripts/check-npm-packages.sh b/.github/scripts/check-npm-packages.sh new file mode 100755 index 0000000..ec73854 --- /dev/null +++ b/.github/scripts/check-npm-packages.sh @@ -0,0 +1,32 @@ +#!/usr/bin/env bash +# Run `npm pack --dry-run` for the main npm package and every per-platform +# package, and assert every tarball contains README.md and LICENSE. Must be +# run from the `npm/` package directory. +set -euo pipefail + +required_assets=("README.md" "LICENSE") + +assert_assets() { + local label="$1" + local files + files=$(npm pack --dry-run --json | jq -r '.[0].files[].path') + for asset in "${required_assets[@]}"; do + if ! grep -qxF "$asset" <<< "$files"; then + echo "ERROR: ${label} is missing ${asset}" >&2 + echo "$files" >&2 + exit 1 + fi + done +} + +for package_json in npm/*/package.json; do + package_dir="$(dirname "$package_json")" + ( + cd "$package_dir" + npm pack --dry-run + assert_assets "$(basename "$package_dir") platform package" + ) +done + +npm pack --dry-run +assert_assets "main package" diff --git a/.github/scripts/stage-npm-assets.sh b/.github/scripts/stage-npm-assets.sh new file mode 100755 index 0000000..bd695cb --- /dev/null +++ b/.github/scripts/stage-npm-assets.sh @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +# Stage README.md and LICENSE into the main npm package directory and every +# per-platform package directory generated by `napi create-npm-dirs`. Must be +# run from the repository root. +set -euo pipefail + +assets=("README.md" "LICENSE") + +for asset in "${assets[@]}"; do + test -f "$asset" || { echo "ERROR: $asset not found at repository root" >&2; exit 1; } + cp "$asset" "npm/$asset" + for package_dir in npm/npm/*/; do + cp "$asset" "${package_dir}${asset}" + done +done diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml index b1a30e0..030786c 100644 --- a/.github/workflows/npm-publish.yml +++ b/.github/workflows/npm-publish.yml @@ -1,8 +1,6 @@ name: Publish npm packages on: - release: - types: [published] workflow_dispatch: inputs: release_tag: @@ -15,21 +13,17 @@ on: description: Release tag to build from required: true type: string - secrets: - NPM_TOKEN: - description: npm token for publishing packages - required: true permissions: contents: read concurrency: - group: npm-publish-${{ inputs.release_tag || github.event.release.tag_name || github.ref_name }} + group: npm-publish-${{ inputs.release_tag || github.ref_name }} cancel-in-progress: false env: CARGO_TERM_COLOR: always - RELEASE_TAG: ${{ inputs.release_tag || github.event.release.tag_name || github.ref_name }} + RELEASE_TAG: ${{ inputs.release_tag || github.ref_name }} jobs: build: @@ -130,6 +124,7 @@ jobs: name: Publish to npm runs-on: ubuntu-latest needs: build + environment: npm permissions: contents: read id-token: write @@ -145,6 +140,9 @@ jobs: node-version: 24 registry-url: https://registry.npmjs.org + - name: Ensure npm CLI supports trusted publishing + run: npm install -g npm@^11.5.1 + - name: Install npm dependencies working-directory: npm run: npm install @@ -176,16 +174,12 @@ jobs: npx napi artifacts --output-dir artifacts --npm-dir npm npx napi prepublish --skip-optional-publish --no-gh-release + - name: Stage README and LICENSE in npm packages + run: ${{ github.workspace }}/.github/scripts/stage-npm-assets.sh + - name: Check npm package contents working-directory: npm - shell: bash - run: | - set -euo pipefail - for package_json in npm/*/package.json; do - package_dir="$(dirname "$package_json")" - (cd "$package_dir" && npm pack --dry-run) - done - npm pack --dry-run + run: ${{ github.workspace }}/.github/scripts/check-npm-packages.sh - name: Publish platform packages if: github.event_name != 'workflow_dispatch' @@ -195,14 +189,10 @@ jobs: set -euo pipefail for package_json in npm/*/package.json; do package_dir="$(dirname "$package_json")" - (cd "$package_dir" && npm publish --provenance --access public) + (cd "$package_dir" && npm publish --access public) done - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} - name: Publish main package if: github.event_name != 'workflow_dispatch' working-directory: npm - run: npm publish --provenance --access public - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} + run: npm publish --access public diff --git a/.github/workflows/release-plz.yml b/.github/workflows/release-plz.yml index 0a15ff4..2a8890b 100644 --- a/.github/workflows/release-plz.yml +++ b/.github/workflows/release-plz.yml @@ -10,9 +10,11 @@ jobs: release-plz-release: name: Release-plz release runs-on: ubuntu-latest + environment: crates-io permissions: contents: write pull-requests: read + id-token: write outputs: releases_created: ${{ steps.release_plz.outputs.releases_created }} release_tag: ${{ steps.release.outputs.release_tag }} @@ -47,6 +49,10 @@ jobs: runtime.wasm=runtime.wasm \ runtime-opt-size.wasm=runtime-opt-size.wasm + - name: Authenticate with crates.io + id: crates_io_auth + uses: rust-lang/crates-io-auth-action@bbd81622f20ce9e2dd9622e3218b975523e45bbe # v1.0.4 + - name: Run release-plz id: release_plz uses: release-plz/action@1528104d2ca23787631a1c1f022abb64b34c1e11 # v0.5.128 @@ -55,7 +61,7 @@ jobs: forge: github env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} + CARGO_REGISTRY_TOKEN: ${{ steps.crates_io_auth.outputs.token }} - name: Extract release tag if: steps.release_plz.outputs.releases_created == 'true' @@ -107,8 +113,6 @@ jobs: uses: ./.github/workflows/npm-publish.yml with: release_tag: ${{ needs.release-plz-release.outputs.release_tag }} - secrets: - NPM_TOKEN: ${{ secrets.NPM_TOKEN }} release-plz-pr: name: Release-plz PR diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 2e786b6..262a26c 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,14 @@ Linux, macOS, and Windows. ### npm package -The npm package is not yet published to the registry. To use it, build from source: +```bash +npm install componentize-qjs +``` + +This pulls in the right prebuilt native binding for your platform via the +`@andreiltd/componentize-qjs-binding-*` optional dependencies. + +If you want to build from source run: ```bash cd npm && npm install && npm run build @@ -353,16 +360,16 @@ Otherwise, call `.drop()` explicitly to release handles. ## Node.js API -The npm package exposes both a CLI and a programmatic API. It is not yet -published to the registry — see [Installation](#installation) for building from -source. +The npm package exposes both a CLI and a programmatic API. ### CLI ```bash -./npm/bin/componentize-qjs --wit hello.wit --js hello.js -o hello.wasm +npx componentize-qjs --wit hello.wit --js hello.js -o hello.wasm ``` +(Or, if you installed the package globally, just `componentize-qjs ...`.) + ### Usage ```js