feat(npm/oxc-minify): npm package and publish script (#8579)

This commit is contained in:
Boshen 2025-01-18 12:12:42 +08:00 committed by GitHub
parent 7f4b302508
commit 2f0314eec2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 363 additions and 0 deletions

View file

@ -0,0 +1,214 @@
name: Release NAPI minify
on:
push:
branches:
- main
paths:
- npm/oxc-minify/package.json # Please only commit this file, so we don't need to wait for test CI to pass.
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
defaults:
run:
shell: bash
jobs:
check:
name: Check version
runs-on: ubuntu-latest
outputs:
version: ${{ env.version }}
version_changed: ${{ steps.version.outputs.changed }}
steps:
- uses: taiki-e/checkout-action@b13d20b7cda4e2f325ef19895128f7ff735c0b3d # v1.3.1
- name: Check version changes
uses: EndBug/version-check@36ff30f37c7deabe56a30caa043d127be658c425 # v2.1.5
id: version
with:
static-checking: localIsNew
file-url: https://unpkg.com/oxc-minify@latest/package.json
file-name: npm/oxc-minify/package.json
- name: Set version name
if: steps.version.outputs.changed == 'true'
env:
VERSION_NUMBER: ${{ steps.version.outputs.version }}
VERSION_TYPE: ${{ steps.version.outputs.version_type }}
run: |
echo "Version change found! New version: ${VERSION_NUMBER} (${VERSION_NUMBER})"
echo "version=${VERSION_NUMBER}" >> $GITHUB_ENV
build:
needs: check
if: needs.check.outputs.version_changed == 'true'
env:
version: ${{ needs.check.outputs.version }}
outputs:
version: ${{ env.version }}
strategy:
fail-fast: false
matrix:
include:
- os: windows-latest
target: x86_64-pc-windows-msvc
code-target: win32-x64-msvc
- os: windows-latest
target: aarch64-pc-windows-msvc
code-target: win32-arm64-msvc
- os: ubuntu-latest
target: x86_64-unknown-linux-gnu
code-target: linux-x64-gnu
- os: ubuntu-latest
target: aarch64-unknown-linux-gnu
code-target: linux-arm64-gnu
- os: ubuntu-latest
target: x86_64-unknown-linux-musl
code-target: linux-x64-musl
- os: ubuntu-latest
target: aarch64-unknown-linux-musl
code-target: linux-arm64-musl
- os: macos-13
target: x86_64-apple-darwin
code-target: darwin-x64
- os: macos-14 # M1
target: aarch64-apple-darwin
code-target: darwin-arm64
name: Package ${{ matrix.target }}
runs-on: ${{ matrix.os }}
steps:
- uses: taiki-e/checkout-action@b13d20b7cda4e2f325ef19895128f7ff735c0b3d # v1.3.1
### install musl dependencies ###
- uses: mlugg/setup-zig@a67e68dc5c8281d9608136d3d7ca1b282213e4ac # v1.2.1
if: ${{ contains(matrix.target, 'musl') }}
with:
version: 0.11.0
- name: Install cargo-zigbuild
if: ${{ contains(matrix.target, 'musl') }}
uses: taiki-e/install-action@df5dec2a2f73ff6dbace3072df1242669b7bb7d1 # v2.47.9
with:
tool: cargo-zigbuild
### install non-musl dependencies ###
- name: Install cross
if: ${{ !contains(matrix.target, 'musl') }}
uses: taiki-e/install-action@df5dec2a2f73ff6dbace3072df1242669b7bb7d1 # v2.47.9
with:
tool: cross
### Build
- name: Add Rust Target
run: rustup target add ${{ matrix.target }}
- name: Build with cross
if: ${{ !contains(matrix.target, 'musl') }}
run: cross build --release -p oxc_minify_napi --target=${{ matrix.target }}
- name: Build with zig
if: ${{ contains(matrix.target, 'musl') }}
env:
RUSTFLAGS: "-C target-feature=-crt-static"
run: cargo zigbuild --release -p oxc_minify_napi --target=${{ matrix.target }}
### Build Done
- name: Move file on ${{ matrix.os }}
run: |
shopt -s extglob
ls target/${{ matrix.target }}/release/*.@(so|dll|dylib)
mv target/${{ matrix.target }}/release/*.@(so|dll|dylib) napi/minify/minify.${{ matrix.code-target }}.node
ls napi/minify
- uses: ./.github/actions/pnpm
if: ${{ contains(matrix.target, 'x86') && !contains(matrix.target, 'musl') }} # Need docker for aarch64
- name: Test
working-directory: napi/minify
if: ${{ contains(matrix.target, 'x86') && !contains(matrix.target, 'musl') }} # Need docker for aarch64
run: pnpm run test
# The binary is zipped to fix permission loss https://github.com/actions/upload-artifact#permission-loss
- name: Archive Binary
if: runner.os == 'Windows'
run: 7z a ${{ matrix.code-target }}.zip napi/minify/minify.${{ matrix.code-target }}.node
# The binary is zipped to fix permission loss https://github.com/actions/upload-artifact#permission-loss
- name: Archive Binary
if: runner.os != 'Windows'
run: tar czf ${{ matrix.code-target }}.tar.gz napi/minify/minify.${{ matrix.code-target }}.node
- name: Upload artifact
uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4
with:
if-no-files-found: error
name: binaries-${{ matrix.code-target }}
path: |
*.zip
*.tar.gz
publish:
name: Publish NAPI
runs-on: ubuntu-latest
permissions:
id-token: write # for `pnpm publish --provenance`
needs:
- build
steps:
- uses: taiki-e/checkout-action@b13d20b7cda4e2f325ef19895128f7ff735c0b3d # v1.3.1
- uses: ./.github/actions/pnpm
- name: Download Artifacts
uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4
with:
merge-multiple: true
- name: Unzip
uses: montudor/action-zip@0852c26906e00f8a315c704958823928d8018b28 # v1.0.0
with:
args: unzip -qq *.zip -d .
- name: Untar
run: ls *.gz | xargs -i tar xvf {}
- name: Generate npm packages
run: |
ls
ls napi/minify
node npm/oxc-minify/scripts/generate-packages.mjs
cat npm/oxc-minify/package.json
for package in npm/oxc-minify*
do
ls $package
cat $package/package.json
echo '----'
done
- name: Publish npm packages as latest
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
# NOTE: The trailing slash on $package/ changes it to publishing the directory
run: |
# publish subpackages first
for package in npm/oxc-minify-*
do
pnpm publish $package/ --provenance --access public --no-git-checks
done
# publish root package last
pnpm publish npm/oxc-minify/ --provenance --access public --no-git-checks

3
npm/oxc-minify/README.md Normal file
View file

@ -0,0 +1,3 @@
# Oxc Minify
This is alpha software and may yield incorrect results, feel free to [submit a bug report](https://github.com/oxc-project/oxc/issues/new?assignees=&labels=C-bug&projects=&template=bug_report.md).

View file

@ -0,0 +1,25 @@
{
"name": "oxc-minify",
"version": "0.46.0",
"description": "Oxc minify Node API",
"keywords": [
"minify"
],
"author": "Boshen and oxc contributors",
"license": "MIT",
"homepage": "https://oxc.rs",
"bugs": "https://github.com/oxc-project/oxc/issues",
"repository": {
"type": "git",
"url": "https://github.com/oxc-project/oxc.git",
"directory": "npm/oxc-minify"
},
"funding": {
"url": "https://github.com/sponsors/Boshen"
},
"main": "index.js",
"files": [
"index.d.ts",
"index.js"
]
}

View file

@ -0,0 +1,120 @@
// Code copied from [Rome](https://github.com/rome/tools/blob/lsp/v0.28.0/npm/rome/scripts/generate-packages.mjs)
import * as fs from 'node:fs';
import { resolve } from 'node:path';
import { fileURLToPath } from 'node:url';
const OXC_ROOT = resolve(fileURLToPath(import.meta.url), '../..');
const PACKAGES_ROOT = resolve(OXC_ROOT, '..');
const BINARY_ROOT = resolve(OXC_ROOT, '../../napi/minify');
const MANIFEST_PATH = resolve(OXC_ROOT, 'package.json');
console.log('OXC_ROOT', OXC_ROOT);
console.log('PACKAGES_ROOT', PACKAGES_ROOT);
console.log('BINARY_ROOT', BINARY_ROOT);
console.log('MANIFEST_PATH', MANIFEST_PATH);
const LIBC_MAPPING = {
'gnu': 'glibc',
'musl': 'musl',
};
const rootManifest = JSON.parse(
fs.readFileSync(MANIFEST_PATH).toString('utf-8'),
);
function package_name(target) {
return `@oxc-minify/binding-${target}`;
}
function generateNativePackage(target) {
const binaryName = `minify.${target}.node`;
const packageRoot = resolve(PACKAGES_ROOT, `oxc-minify-${target}`);
const binarySource = resolve(BINARY_ROOT, binaryName);
const binaryTarget = resolve(packageRoot, binaryName);
// Remove the directory just in case it already exists (it's autogenerated
// so there shouldn't be anything important there anyway)
fs.rmSync(packageRoot, { recursive: true, force: true });
// Create the package directory
console.log(`Create directory ${packageRoot}`);
fs.mkdirSync(packageRoot);
// Generate the package.json manifest
const { version, author, license, homepage, bugs, repository } = rootManifest;
const triple = target.split('-');
const platform = triple[0];
const arch = triple[1];
const libc = triple[2] && LIBC_MAPPING[triple[2]] && { libc: [LIBC_MAPPING[triple[2]]] };
const manifest = {
name: package_name(target),
version,
main: binaryName,
license,
author,
bugs,
homepage,
repository,
files: [binaryName],
cpu: [arch],
os: [platform],
...libc,
};
const manifestPath = resolve(packageRoot, 'package.json');
console.log(`Create manifest ${manifestPath}`);
fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 2));
console.log(`Copy binary ${binaryTarget}`);
fs.copyFileSync(binarySource, binaryTarget);
}
function writeManifest() {
const packageRoot = resolve(PACKAGES_ROOT, 'oxc-minify');
const manifestPath = resolve(packageRoot, 'package.json');
console.log('packageRoot', packageRoot);
const manifestData = JSON.parse(
fs.readFileSync(manifestPath).toString('utf-8'),
);
const nativePackages = TARGETS.map((target) => [
package_name(target),
rootManifest.version,
]);
manifestData['version'] = rootManifest.version;
manifestData['optionalDependencies'] = Object.fromEntries(nativePackages);
console.log('manifestPath', manifestPath);
console.log('manifestData', manifestData);
const content = JSON.stringify(manifestData, null, 2);
fs.writeFileSync(manifestPath, content);
let files = ['index.js', 'index.d.ts'];
for (const file of files) {
fs.copyFileSync(resolve(BINARY_ROOT, file), resolve(packageRoot, file));
}
}
// NOTE: Must update npm/oxc-minify/package.json
const TARGETS = [
'win32-x64-msvc',
'win32-arm64-msvc',
'linux-x64-gnu',
'linux-arm64-gnu',
'linux-x64-musl',
'linux-arm64-musl',
'darwin-x64',
'darwin-arm64',
];
for (const target of TARGETS) {
generateNativePackage(target);
}
writeManifest();

View file

@ -7,6 +7,7 @@ versioned_files = [
"Cargo.toml",
"npm/oxc-parser/package.json",
"npm/oxc-transform/package.json",
"npm/oxc-minify/package.json",
"npm/oxc-types/package.json",
"wasm/parser/package.json",
]