Skip to content

Use PNPM and enforce js bundling in PR #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nick-fields wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Use PNPM and enforce js bundling in PR #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c95842e
minor: migrate to pnpm
nick-fields Feb 25, 2025
6513c5e
undo js generation, will test generating this in CI
nick-fields Feb 25, 2025
d4bdaee
configure pnpm and cache, move setup to composite action
nick-fields Feb 25, 2025
7082f1b
rebundle and commit if changes found
nick-fields Feb 25, 2025
fd45cc9
checkout branch not sha
nick-fields Feb 25, 2025
197f6ab
checkout branch not sha
nick-fields Feb 25, 2025
a8fec9e
patch: regenerated bundle
github-actions[bot] Feb 25, 2025
82da33c
Merge branch 'master' into nrf/pnpm
nick-fields Feb 25, 2025
12ca352
checkout branch not sha
nick-fields Feb 25, 2025
ba8a013
patch: regenerated bundle
github-actions[bot] Feb 25, 2025
fe62d59
patch: re-run CI via label when changes found
nick-fields Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/actions/setup/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Setup Node, PNPM, cache, and install dependencies
description: Sets up job to use the nodejs version in .nvmrc, pnpm, cache, and install dependencies

runs:
using: composite
steps:
- uses: pnpm/action-setup@v3
with:
version: 9.5.0
- uses: actions/setup-node@v4
with:
node-version-file: ./.nvmrc
cache: 'pnpm'
- run: pnpm install
shell: bash
190 changes: 106 additions & 84 deletions .github/workflows/ci_cd.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,88 @@
name: CI/CD

# PRs come in via the GitHub UI that skip pre-commit hooks which bundle the code. So we have to check that the code is bundled properly here and potentially re-commit if changes are found
concurrency:
group: ${{ github.workflow }}-${{ github.ref_name }}
cancel-in-progress: ${{ github.ref_name == 'master' && false || true}}

on:
# only on PRs into and merge to default branch
pull_request:
types:
- opened
- synchronize
- reopened
- labeled
branches:
- master
push:
branches:
- master

env:
BRANCH: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.ref || github.ref_name }}
PR_TRIGGERED: ${{ github.event_name == 'pull_request' && github.event.action != 'labeled' }}
jobs:
setup:
# Skip running if labeled event but not rerun, otehrwise its a supported trigger event
if: ${{ github.event.label.name == 'rerun' || github.event.action != 'labeled' }}
name: Setup
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: ${{ env.BRANCH }}
- name: Setup and cache for later jobs
uses: ./.github/actions/setup
# GHA requires bundled code to be commited so we bundle automatically via pre-commit hook. However, most contributions come in through the GH UI which skips hooks.
# So bundle again here just in case, and if changes are found then commit them to ensure we're testing the correct code.
# But GHA does not trigger on changes made via the default GH token, so we need to label the PR to re-run CI.
# Alternatives could be using a PAT (rotation/security burden), GH App (overkill/maintenance), or something like pre-commit.ci (not convincing). Lets try this first though
- name: Check for bundle changes after install
# Only run if not a push event since we only trigger this on the default branch and we don't want to make any non-PR changes there
if: ${{ github.event_name != 'push' }}
id: changes
run: |
if [[ -n "$(git status --porcelain)" ]]; then
echo "CHANGES_FOUND=true" >> $GITHUB_OUTPUT
else
echo "No changes detected."
echo "CHANGES_FOUND=false" >> $GITHUB_OUTPUT
fi
- name: Commit and push changes if found
if: ${{ steps.changes.outputs.CHANGES_FOUND == 'true' }}
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
git add .
git commit -m "patch: regenerated bundle"
git push
- name: Label PR to re-trigger CI
if: ${{ steps.changes.outputs.CHANGES_FOUND == 'true' }}
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh pr edit ${{ github.event.pull_request.number }} --add-label "rerun"
- name: Remove label after clean re-run
# Only remove label if the PR was labeled with rerun and no changes were found. Changes found indicate a problem since they should have been previously committed
if: ${{ steps.changes.outputs.CHANGES_FOUND == 'false' && github.event.label.name == 'rerun' }}
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh pr edit ${{ github.event.pull_request.number }} --remove-label "rerun"

ci_unit:
name: Run Unit Tests
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup
- name: Run Unit Tests
run: npm test
- uses: codecov/codecov-action@v5
Expand All @@ -31,15 +93,12 @@ jobs:
ci_integration:
name: Run Integration Tests
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup

- name: happy-path
id: happy_path
Expand Down Expand Up @@ -141,15 +200,12 @@ jobs:
ci_integration_envvar:
name: Run Integration Env Var Tests
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup
- name: env-vars-passed-through
uses: ./
env:
Expand All @@ -162,15 +218,12 @@ jobs:
ci_integration_large_output:
name: Run Integration Large Output Tests
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup
- name: Test 100MiB of output can be processed
id: large-output
continue-on-error: true
Expand All @@ -193,15 +246,12 @@ jobs:
ci_integration_retry_on_exit_code:
name: Run Integration retry_on_exit_code Tests
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup
- name: retry_on_exit_code (with expected error code)
id: retry_on_exit_code_expected
uses: ./
Expand Down Expand Up @@ -241,15 +291,12 @@ jobs:
ci_integration_continue_on_error:
name: Run Integration continue_on_error Tests
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup
- name: happy-path (continue_on_error)
id: happy_path_continue_on_error
uses: ./
Expand Down Expand Up @@ -288,15 +335,12 @@ jobs:
ci_integration_retry_wait_seconds:
name: Run Integration Tests (retry_wait_seconds)
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup

- name: sad-path (retry_wait_seconds)
id: sad_path_wait_sec
Expand Down Expand Up @@ -324,15 +368,12 @@ jobs:
ci_integration_on_retry_cmd:
name: Run Integration Tests (on_retry_command)
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup

- name: new-command-on-retry
id: new-command-on-retry
Expand Down Expand Up @@ -367,15 +408,12 @@ jobs:
ci_integration_timeout_seconds:
name: Run Integration Timeout Tests (seconds)
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup

- name: sad-path (timeout)
id: sad_path_timeout
Expand All @@ -397,15 +435,12 @@ jobs:
ci_integration_timeout_retry_on_timeout:
name: Run Integration Timeout Tests (retry_on timeout)
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup

- name: retry_on (timeout)
id: retry_on_timeout
Expand All @@ -428,15 +463,12 @@ jobs:
ci_integration_timeout_retry_on_error:
name: Run Integration Timeout Tests (retry_on error)
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup

- name: retry_on (error) fails early if timeout encountered
id: retry_on_error_fail
Expand All @@ -463,15 +495,12 @@ jobs:
ci_integration_timeout_minutes:
name: Run Integration Timeout Tests (minutes)
runs-on: ubuntu-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup

- name: sad-path (timeout minutes)
id: sad_path_timeout_minutes
Expand All @@ -493,15 +522,12 @@ jobs:
ci_windows:
name: Run Windows Tests
runs-on: windows-latest
needs: setup
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup
- name: Powershell test
uses: ./
with:
Expand Down Expand Up @@ -572,12 +598,8 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Setup
uses: ./.github/actions/setup
- name: Release
id: semantic
uses: cycjimmy/semantic-release-action@v4
Expand Down
Loading
Loading