Update node release based on maplibre-js release workflow - v2 with changelog (#1995)

Co-authored-by: mwilsnd <mwilsnd@gmail.com>
Co-authored-by: Bart Louwers <bart@emeel.net>
Co-authored-by: Bart Louwers <bart.louwers@gmail.com>
This commit is contained in:
Andrew Calcutt
2024-01-08 12:51:31 -05:00
committed by GitHub
parent 8c940cb7a6
commit 43e52d054e
9 changed files with 159 additions and 387 deletions

View File

@@ -1,259 +0,0 @@
# Note: this workflow has been copied from node-ci.yml
# That workflow runs for main, this one runs for opengl-2 due to
# the lacking OpenGL ES 3.0 support on macOS.
# Once the Metal backend is completed this workflow can be removed.
name: node-ci
on:
workflow_dispatch:
push:
branches:
- opengl-2
tags:
- 'node-*'
paths:
- CMakeLists.txt
- "platform/default/**"
- 'platform/node/**'
- 'platform/windows/**'
- 'platform/darwin/**'
- 'platform/macos/**'
- 'platform/ios/platform/darwin/**'
- 'platform/ios/platform/macos/**'
- ".github/workflows/node-ci.yml"
- "bin/**"
- "expression-test/**"
- "include/**"
- "metrics/**"
- "render-test/**"
- "scripts/**"
- "src/**"
- "test/**"
- "vendor/**"
- ".gitmodules"
- "!**/*.md"
pull_request:
branches:
- opengl-2
paths:
- CMakeLists.txt
- "platform/default/**"
- 'platform/node/**'
- 'platform/windows/**'
- 'platform/darwin/**'
- 'platform/macos/**'
- 'platform/ios/platform/darwin/**'
- 'platform/ios/platform/macos/**'
- ".github/workflows/node-ci.yml"
- "bin/**"
- "expression-test/**"
- "include/**"
- "metrics/**"
- "render-test/**"
- "scripts/**"
- "src/**"
- "test/**"
- "vendor/**"
- ".gitmodules"
- "!**/*.md"
concurrency:
# cancel jobs on PRs only
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
jobs:
test:
runs-on: ${{ matrix.runs-on }}
strategy:
fail-fast: false
matrix:
include:
- runs-on: macos-12
arch: x86_64
continue-on-error: true
env:
BUILDTYPE: 'Release'
defaults:
run:
working-directory: ./
shell: bash
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup submodules
shell: bash
run: |
auth_header="$(git config --local --get http.https://github.com/.extraheader)"
git submodule sync --recursive
git -c core.longpaths=true -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive || true
- name: Get OS Architecture
if: runner.os == 'MacOS' || runner.os == 'Linux'
run: uname -m
- name: Install dependencies (MacOS)
if: runner.os == 'MacOS'
env:
HOMEBREW_NO_AUTO_UPDATE: 1
HOMEBREW_NO_INSTALL_CLEANUP: 1
run: |
brew list cmake || brew install cmake
brew list ccache || brew install ccache
brew list ninja || brew install ninja
brew list pkg-config || brew install pkg-config
brew list glfw || brew install glfw
brew list libuv || brew install libuv
- name: Install dependencies (Linux)
if: runner.os == 'Linux'
env:
DEBIAN_FRONTEND: noninteractive
run: |
sudo apt-get update
sudo apt-get install -y \
ccache \
cmake \
ninja-build \
pkg-config \
xvfb \
libcurl4-openssl-dev \
libglfw3-dev \
libuv1-dev \
g++-10 \
libc++-9-dev \
libc++abi-9-dev \
libjpeg-dev \
libpng-dev
/usr/sbin/update-ccache-symlinks
- name: Setup node
uses: actions/setup-node@v4
with:
node-version: 18
- name: npm ci
run: npm ci --ignore-scripts
- name: Set up msvc dev cmd (Windows)
if: runner.os == 'Windows'
uses: ilammy/msvc-dev-cmd@v1
- name: Set up ccache (MacOS/Linux)
if: runner.os == 'MacOS' || runner.os == 'Linux'
uses: hendrikmuhs/ccache-action@v1
with:
key: ${{ matrix.runs-on }}-${{ env.BUILDTYPE }}-${{ github.job }}-${{ github.ref }}-${{ github.sha }}-${{ github.head_ref }}
restore-keys: |
${{ matrix.runs-on }}-${{ env.BUILDTYPE }}-${{ github.job }}-${{ github.ref }}-${{ github.sha }}
${{ matrix.runs-on }}-${{ env.BUILDTYPE }}-${{ github.job }}-${{ github.ref }}
${{ matrix.runs-on }}-${{ env.BUILDTYPE }}-${{ github.job }}
- name: Set up ccache (Windows)
if: runner.os == 'Windows'
uses: hendrikmuhs/ccache-action@v1
with:
variant: 'sccache'
key: ${{ matrix.runs-on }}-${{ env.BUILDTYPE }}-${{ github.job }}-${{ github.ref }}-${{ github.sha }}-${{ github.head_ref }}
restore-keys: |
${{ matrix.runs-on }}-${{ env.BUILDTYPE }}-${{ github.job }}-${{ github.ref }}-${{ github.sha }}
${{ matrix.runs-on }}-${{ env.BUILDTYPE }}-${{ github.job }}-${{ github.ref }}
${{ matrix.runs-on }}-${{ env.BUILDTYPE }}-${{ github.job }}
- name: Configure maplibre-native (MacOS)
if: runner.os == 'MacOS'
run: |
cmake . -B build \
-G Ninja \
-DCMAKE_BUILD_TYPE=${{ env.BUILDTYPE }} \
-DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
- name: Configure maplibre-native (Linux)
if: runner.os == 'Linux'
run: |
cmake . -B build \
-G Ninja \
-DCMAKE_BUILD_TYPE=${{ env.BUILDTYPE }} \
-DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
-DCMAKE_C_COMPILER=gcc-10 \
-DCMAKE_CXX_COMPILER=g++-10
- name: "Create directory '${{ github.workspace }}/platform/windows/vendor/vcpkg/bincache' (Windows)"
if: runner.os == 'Windows'
run: mkdir -p ${{ github.workspace }}/platform/windows/vendor/vcpkg/bincache
shell: bash
- name: Restore vcpkg cache (Windows)
if: runner.os == 'Windows'
uses: actions/cache@v3
with:
path: |
${{ github.workspace }}/platform/windows/vendor/vcpkg
!${{ github.workspace }}/platform/windows/vendor/vcpkg/buildtrees
!${{ github.workspace }}/platform/windows/vendor/vcpkg/packages
!${{ github.workspace }}/platform/windows/vendor/vcpkg/downloads
!${{ github.workspace }}/platform/windows/vendor/vcpkg/installed
key: |
${{ matrix.runs-on }}-${{ env.BUILDTYPE }}-${{ github.job }}-${{ hashFiles( '.git/modules/platform/windows/vendor/vcpkg/HEAD' ) }}-${{ hashFiles( 'platform/windows/Get-VendorPackages.ps1' ) }}
- name: Configure maplibre-native (Windows)
if: runner.os == 'Windows'
run: |
cmake . -B build \
-G Ninja \
-DCMAKE_BUILD_TYPE=${{ env.BUILDTYPE }} \
-DCMAKE_CXX_COMPILER_LAUNCHER=sccache
- name: Build maplibre-native (MacOS/Linux)
if: runner.os == 'MacOS' || runner.os == 'Linux'
run: |
cmake --build build -j "$(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null)"
- name: Build maplibre-native (Windows)
if: runner.os == 'Windows'
run: |
cmake --build build
- name: Run render tests on macOS
if: runner.os == 'macOS'
run: set -o pipefail && ./build/mbgl-render-test-runner --manifestPath metrics/macos-xcode11-release-style.json
- name: Upload render test artifacts (MacOS)
if: runner.os == 'MacOS'
uses: actions/upload-artifact@v4
with:
name: render-query-test-results
path: metrics/macos-xcode11-release-style.html
- name: Test (Linux)
if: runner.os == 'Linux'
run: xvfb-run --auto-servernum npm test
- name: Test (MacOS)
if: runner.os == 'MacOS'
run: npm test
- name: Test (Windows)
if: runner.os == 'Windows'
shell: pwsh
env:
LIBGL_ALWAYS_SOFTWARE: true
GALLIUM_DRIVER: softpipe
run: |
Invoke-WebRequest https://github.com/pal1000/mesa-dist-win/releases/download/22.3.5/mesa3d-22.3.5-release-msvc.7z -OutFile mesa3d.7z
& 'C:\Program Files\7-Zip\7z.exe' e -olib\node-v108 .\mesa3d.7z x64\opengl32.dll x64\libgallium_wgl.dll x64\libGLESv2.dll x64\libglapi.dll
npm test
# On PRs make sure that the npm package can be packaged.
- name: Pack
if: github.ref != 'refs/heads/main'
run: |
npm pack --dry-run

View File

@@ -73,6 +73,12 @@ jobs:
arch: x86_64
- runs-on: [self-hosted, linux, ARM64]
arch: arm64
# Disabled until Metal backend is complete
# A release for macOS can be made from the opengl-2 branch
# - runs-on: macos-12
# arch: x86_64
# - runs-on: [self-hosted, macOS, ARM64]
# arch: arm64
- runs-on: windows-2022
arch: x86_64
continue-on-error: true
@@ -134,10 +140,10 @@ jobs:
libwebp-dev
/usr/sbin/update-ccache-symlinks
- name: Setup node
- name: Use Node.js from nvmrc
uses: actions/setup-node@v4
with:
node-version: 20
node-version-file: '.nvmrc'
- name: npm ci
run: npm ci --ignore-scripts
@@ -155,7 +161,7 @@ jobs:
"PATH=$env:PATH" | Out-File -FilePath $env:GITHUB_ENV -Append
- name: Setup cmake (Linux)
if: runner.os == 'Linux' && runner.arch != 'arm64'
if: runner.os == 'Linux' && matrix.arch != 'arm64'
uses: jwlawson/actions-setup-cmake@v1.14
with:
cmake-version: "3.19.x"
@@ -278,6 +284,5 @@ jobs:
# On PRs make sure that the npm package can be packaged.
- name: Pack
if: github.ref != 'refs/heads/main'
run: |
npm pack --dry-run

View File

@@ -1,54 +1,44 @@
name: node-release
on:
push:
branches: [main]
workflow_dispatch:
inputs:
version:
description: Choose a release type
required: true
type: choice
options:
- prerelease
- prepatch
- preminor
- premajor
- patch
- minor
- major
jobs:
bump_version:
runs-on: ubuntu-20.04
release-check:
name: Check if version is published
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.NODE_PRE_GYP_GITHUB_TOKEN }}
- name: Setup node
- name: Use Node.js from nvmrc
uses: actions/setup-node@v4
with:
node-version: 18
node-version-file: '.nvmrc'
- name: npm version
- name: Check if version is published
id: check
run: |
echo "NPM_VERSION=$(npm version ${{ github.event.inputs.version }} --preid pre --no-git-tag-version)" >> "$GITHUB_ENV"
- name: Push version to git
run: |
git config user.name github-actions
git config user.email github-actions@github.com
git commit -a -m "Update node version to ${{ env.NPM_VERSION }} (${{ github.event.inputs.version }})"
git push
currentVersion="$( node -e "console.log(require('./package.json').version)" )"
isPublished="$( npm view @maplibre/maplibre-gl-native versions --json | jq -c --arg cv "$currentVersion" 'any(. == $cv)' )"
echo "published=$isPublished" >> "$GITHUB_OUTPUT"
echo "currentVersion: $currentVersion"
echo "isPublished: $isPublished"
outputs:
published: ${{ steps.check.outputs.published }}
publish_binaries:
needs: release-check
if: ${{ needs.release-check.outputs.published == 'false' }}
runs-on: ${{ matrix.runs-on }}
permissions:
contents: write
strategy:
fail-fast: false
matrix:
@@ -59,14 +49,12 @@ jobs:
arch: arm64
# Disabled until Metal backend is complete
# A release for macOS can be made from the opengl-2 branch
# - runs-on: macos-12
# arch: x86_64
# - runs-on: macos-12-arm
# - runs-on: [self-hosted, macOS, ARM64]
# arch: arm64
- runs-on: windows-2022
arch: x86_64
needs: bump_version
continue-on-error: true
env:
BUILDTYPE: "Release"
@@ -82,9 +70,6 @@ jobs:
with:
fetch-depth: 0
- name: Get Latest Version
run: git pull
- name: Setup submodules
shell: bash
run: |
@@ -129,10 +114,10 @@ jobs:
libwebp-dev
/usr/sbin/update-ccache-symlinks
- name: Setup node
- name: Use Node.js from nvmrc
uses: actions/setup-node@v4
with:
node-version: 20
node-version-file: '.nvmrc'
- name: npm ci
run: npm ci --ignore-scripts
@@ -150,7 +135,7 @@ jobs:
"PATH=$env:PATH" | Out-File -FilePath $env:GITHUB_ENV -Append
- name: Setup cmake (Linux)
if: runner.os == 'Linux' && runner.arch != 'arm64'
if: runner.os == 'Linux' && matrix.arch != 'arm64'
uses: jwlawson/actions-setup-cmake@v1.14
with:
cmake-version: "3.19.x"
@@ -242,30 +227,30 @@ jobs:
cmake --build build
- name: Publish X64 Release to Github
if: github.ref == 'refs/heads/main' && matrix.arch == 'x86_64'
if: matrix.arch == 'x86_64'
env:
PUBLISH: true
BUILDTYPE: RelWithDebInfo
NODE_PRE_GYP_GITHUB_TOKEN: ${{ secrets.NODE_PRE_GYP_GITHUB_TOKEN }}
NODE_PRE_GYP_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
./platform/node/scripts/publish.sh
- name: Publish ARM Release to Github
if: github.ref == 'refs/heads/main' && matrix.arch == 'arm64'
if: matrix.arch == 'arm64'
env:
PUBLISH: true
BUILDTYPE: RelWithDebInfo
NODE_PRE_GYP_GITHUB_TOKEN: ${{ secrets.NODE_PRE_GYP_GITHUB_TOKEN }}
NODE_PRE_GYP_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
./platform/node/scripts/publish.sh --target_arch=arm64
publish_npm:
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
needs: publish_binaries
permissions:
contents: write
defaults:
run:
working-directory: ./
shell: bash
steps:
@@ -273,16 +258,48 @@ jobs:
with:
fetch-depth: 0
- name: Get Latest Version
run: git pull
- name: Setup node
- name: Use Node.js from nvmrc
uses: actions/setup-node@v4
with:
node-version: 20
node-version-file: '.nvmrc'
- name: Get version
id: package-version
uses: martinbeentjes/npm-get-version-action@v1.3.1
- name: npm ci
run: npm ci --ignore-scripts
- name: Prepare release
id: prepare_release
run: |
RELEASE_TYPE="$(node -e "console.log(require('semver').prerelease('${{ steps.package-version.outputs.current-version }}') ? 'prerelease' : 'regular')")"
if [[ $RELEASE_TYPE == 'regular' ]]; then
echo "prerelease=false" >> "$GITHUB_OUTPUT"
else
echo "prerelease=true" >> "$GITHUB_OUTPUT"
fi
- name: Extract changelog for version
run: |
awk '/^##/ { p = 0 }; p == 1 { print }; $0 == "## ${{ steps.package-version.outputs.current-version }}" { p = 1 };' platform/node/CHANGELOG.md > changelog_for_version.md
cat changelog_for_version.md
- name: Update Release Notes
id: update_release_notes
uses: ncipollo/release-action@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag: node-v${{ steps.package-version.outputs.current-version }}
name: node-v${{ steps.package-version.outputs.current-version }}
bodyFile: changelog_for_version.md
allowUpdates: true
draft: false
prerelease: ${{ steps.prepare_release.outputs.prerelease }}
- name: Publish to NPM (release)
if: github.ref == 'refs/heads/main' && (github.event.inputs.version == 'patch' || github.event.inputs.version == 'minor' || github.event.inputs.version == 'major')
if: ${{ steps.prepare_release.outputs.prerelease == 'false' }}
run: |
npm config set //registry.npmjs.org/:_authToken "${NPM_TOKEN}"
npm publish --access public
@@ -290,7 +307,7 @@ jobs:
NPM_TOKEN: ${{ secrets.NPM_ORG_TOKEN }}
- name: Publish to NPM (prerelease)
if: github.ref == 'refs/heads/main' && (github.event.inputs.version == 'prerelease' || github.event.inputs.version == 'prepatch' || github.event.inputs.version == 'preminor' || github.event.inputs.version == 'premajor')
if: ${{ steps.prepare_release.outputs.prerelease == 'true' }}
run: |
npm config set //registry.npmjs.org/:_authToken "${NPM_TOKEN}"
npm publish --tag next --access public