Skip to content

Commit 0cc60c3

Browse files
authored
feat(actions)!: simplify package tooling and dependency setup (#564)
* feat(actions)!: simplify package tooling and dependency setup Centralize native pack commands, package prepared files, and default installation lifecycle scripts to disabled. Group the existing package actions and configure Renovate for the shared runtime. BREAKING CHANGE: use actions/package/create and actions/package/publish. Callers prepare source, tooling and versions before packaging. Installation hooks require ignore-scripts: false. * ci: run checks for pull requests targeting stacked branches * fix(setup-node): maintain the pnpm fallback with Renovate * ci: preserve the existing pull request workflow trigger
1 parent b7eadcf commit 0cc60c3

29 files changed

Lines changed: 643 additions & 419 deletions

‎.github/renovate.json‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": ["config:recommended"],
4+
"enabledManagers": ["github-actions", "nodenv", "custom.regex"],
5+
"semanticCommits": "enabled",
6+
"minimumReleaseAge": "7 days",
7+
"minimumReleaseAgeBehaviour": "timestamp-optional",
8+
"pinDigests": true,
9+
"packageRules": [
10+
{
11+
"description": "Dependabot is the primary dependency updater.",
12+
"matchPackageNames": ["*"],
13+
"enabled": false
14+
},
15+
{
16+
"description": "Update docker:// action references unsupported by Dependabot.",
17+
"matchDatasources": ["docker"],
18+
"matchDepTypes": ["docker"],
19+
"enabled": true
20+
},
21+
{
22+
"description": "Update the shared Node.js runtime from the root version file.",
23+
"matchManagers": ["nodenv"],
24+
"matchFileNames": [".node-version"],
25+
"enabled": true,
26+
"automerge": false
27+
},
28+
{
29+
"description": "Update the pnpm fallback used when projects do not declare packageManager.",
30+
"matchManagers": ["custom.regex"],
31+
"matchPackageNames": ["pnpm"],
32+
"enabled": true,
33+
"automerge": false
34+
}
35+
],
36+
"customManagers": [
37+
{
38+
"customType": "regex",
39+
"managerFilePatterns": ["/^actions/setup-node/action\\.yml$/"],
40+
"matchStrings": [
41+
"DEFAULT_PNPM_VERSION: \"(?<currentValue>[^\"\\r\\n]+)\""
42+
],
43+
"datasourceTemplate": "npm",
44+
"depNameTemplate": "pnpm",
45+
"versioningTemplate": "npm"
46+
}
47+
]
48+
}

‎.github/workflows/__renovate.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Internal - Renovate dependency updates
3+
4+
on: # yamllint disable-line rule:truthy
5+
workflow_dispatch:
6+
schedule:
7+
- cron: "23 4 * * 5"
8+
9+
permissions: {}
10+
11+
concurrency:
12+
group: ${{ github.workflow }}
13+
cancel-in-progress: false
14+
15+
jobs:
16+
renovate:
17+
runs-on: ubuntu-latest
18+
timeout-minutes: 30
19+
steps:
20+
- name: Generate GitHub App token
21+
id: generate-token
22+
uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0
23+
with:
24+
client-id: ${{ vars.CI_BOT_APP_CLIENT_ID }}
25+
private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }} # zizmor: ignore[secrets-outside-env] scheduled maintenance uses the CI bot
26+
permission-checks: read
27+
permission-contents: write
28+
permission-issues: write
29+
permission-pull-requests: write
30+
permission-statuses: write
31+
permission-workflows: write
32+
33+
- name: Run Renovate
34+
uses: renovatebot/github-action@1c0cf989c02653fba0efe7ca5772338860ca71dc # v46.3.12
35+
with:
36+
token: ${{ steps.generate-token.outputs.token }}
37+
env:
38+
RENOVATE_PLATFORM: github
39+
RENOVATE_REPOSITORIES: ${{ github.repository }}
40+
RENOVATE_ONBOARDING: "false"
41+
RENOVATE_REQUIRE_CONFIG: required
42+
RENOVATE_USERNAME: ${{ steps.generate-token.outputs.app-slug }}[bot]
43+
RENOVATE_PLATFORM_COMMIT: enabled

‎.github/workflows/__shared-ci.yml‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ jobs:
3838
permissions:
3939
contents: read
4040

41-
test-action-package:
42-
name: Test action "package"
41+
test-action-package-create:
42+
name: Test action "package/create"
4343
needs: linter
44-
uses: $/.github/workflows/__test-action-package.yml
44+
uses: $/.github/workflows/__test-action-package-create.yml
4545
permissions:
4646
contents: read
4747

@@ -52,10 +52,10 @@ jobs:
5252
permissions:
5353
contents: read
5454

55-
test-action-publish:
56-
name: Test action "publish"
55+
test-action-package-publish:
56+
name: Test action "package/publish"
5757
needs: linter
58-
uses: $/.github/workflows/__test-action-publish.yml
58+
uses: $/.github/workflows/__test-action-package-publish.yml
5959
permissions:
6060
actions: read
6161
contents: read
@@ -65,6 +65,7 @@ jobs:
6565
needs: linter
6666
uses: $/.github/workflows/__test-workflow-continuous-integration.yml
6767
permissions:
68+
actions: read
6869
attestations: write
6970
contents: read
7071
packages: write

‎.github/workflows/__test-action-get-package-manager.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,31 @@ jobs:
2020
cache-dependency-path: "tests/npm/**/package-lock.json"
2121
install-command: npm ci
2222
run-script-command: npm run
23+
pack-command: 'npm pack --ignore-scripts --pack-destination "${PACK_DESTINATION:?PACK_DESTINATION is required}"'
2324

2425
- working-directory: tests/pnpm
2526
package-manager: pnpm
2627
lock-file: pnpm-lock.yaml
2728
cache-dependency-path: "tests/pnpm/**/pnpm-lock.yaml"
2829
install-command: pnpm install --frozen-lockfile
2930
run-script-command: pnpm
31+
pack-command: 'pnpm pack --config.ignore-scripts=true --pack-destination "${PACK_DESTINATION:?PACK_DESTINATION is required}"'
3032

3133
- working-directory: tests/pnpm-package-manager
3234
package-manager: pnpm
3335
lock-file: pnpm-lock.yaml
3436
cache-dependency-path: "tests/pnpm-package-manager/**/pnpm-lock.yaml"
3537
install-command: pnpm install --frozen-lockfile
3638
run-script-command: pnpm
39+
pack-command: 'pnpm pack --config.ignore-scripts=true --pack-destination "${PACK_DESTINATION:?PACK_DESTINATION is required}"'
3740

3841
- working-directory: tests/yarn
3942
package-manager: yarn
4043
lock-file: yarn.lock
4144
cache-dependency-path: "tests/yarn/**/yarn.lock"
4245
install-command: yarn install --frozen-lockfile
4346
run-script-command: yarn
47+
pack-command: 'yarn pack --ignore-scripts --filename "${PACK_DESTINATION:?PACK_DESTINATION is required}/package.tgz"'
4448
steps:
4549
- name: Arrange - Checkout sources
4650
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
@@ -63,6 +67,8 @@ jobs:
6367
EXPECTED_INSTALL_COMMAND: ${{ matrix.install-command }}
6468
ACTUAL_RUN_SCRIPT_COMMAND: ${{ steps.act-get-package-manager.outputs.run-script-command }}
6569
EXPECTED_RUN_SCRIPT_COMMAND: ${{ matrix.run-script-command }}
70+
ACTUAL_PACK_COMMAND: ${{ steps.act-get-package-manager.outputs.pack-command }}
71+
EXPECTED_PACK_COMMAND: ${{ matrix.pack-command }}
6672
run: |
6773
if [ "$ACTUAL_PACKAGE_MANAGER" != "$EXPECTED_PACKAGE_MANAGER" ]; then
6874
echo "get-package-manager outputs result is not valid"
@@ -83,3 +89,8 @@ jobs:
8389
echo "get-package-manager outputs run-script-command is not valid"
8490
exit 1
8591
fi
92+
93+
if [ "$ACTUAL_PACK_COMMAND" != "$EXPECTED_PACK_COMMAND" ]; then
94+
echo "get-package-manager output pack-command is not valid"
95+
exit 1
96+
fi

.github/workflows/__test-action-package.yml renamed to .github/workflows/__test-action-package-create.yml

Lines changed: 89 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Internal - Tests for "package" action
1+
name: Internal - Tests for "package/create" action
22

33
on:
44
workflow_call:
@@ -7,7 +7,7 @@ permissions: {}
77

88
jobs:
99
test:
10-
name: Test "package" (${{ matrix.working-directory }})
10+
name: Test "package/create" (${{ matrix.working-directory }})
1111
runs-on: ubuntu-latest
1212
permissions:
1313
contents: read
@@ -21,26 +21,84 @@ jobs:
2121
include:
2222
- working-directory: tests/npm
2323
artifact-suffix: npm
24+
package-manager: npm
2425
- working-directory: tests/pnpm
2526
artifact-suffix: pnpm
27+
package-manager: pnpm
2628
- working-directory: tests/pnpm-package-manager
2729
artifact-suffix: pnpm-package-manager
30+
package-manager: pnpm
2831
- working-directory: tests/yarn
2932
artifact-suffix: yarn
33+
package-manager: yarn
3034
steps:
3135
- name: Arrange - Checkout sources
3236
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
3337
with:
3438
persist-credentials: false
3539

36-
- name: Act - Run "package" action
40+
- name: Arrange - Configure the package runtime
41+
uses: $/actions/setup-node
42+
with:
43+
working-directory: ${{ matrix.working-directory }}
44+
install-dependencies: "false"
45+
46+
- name: Arrange - Record native package manager calls
47+
env:
48+
PACKAGE_MANAGER: ${{ matrix.package-manager }}
49+
run: |
50+
wrapper_directory="$(mktemp -d)"
51+
echo "NATIVE_PACKAGE_MANAGER=$(command -v "$PACKAGE_MANAGER")" >> "$GITHUB_ENV"
52+
echo "PACK_COMMAND_LOG=$wrapper_directory/pack.log" >> "$GITHUB_ENV"
53+
cat > "$wrapper_directory/$PACKAGE_MANAGER" <<'SH'
54+
#!/usr/bin/env bash
55+
set -euo pipefail
56+
printf '%s\n' "$*" >> "$PACK_COMMAND_LOG"
57+
exec "$NATIVE_PACKAGE_MANAGER" "$@"
58+
SH
59+
chmod +x "$wrapper_directory/$PACKAGE_MANAGER"
60+
echo "$wrapper_directory" >> "$GITHUB_PATH"
61+
62+
- name: Arrange - Prepare files and hooks that must not run
63+
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
64+
env:
65+
WORKING_DIRECTORY: ${{ matrix.working-directory }}
66+
with:
67+
script: |
68+
const fs = require('node:fs');
69+
const path = require('node:path');
70+
const directory = process.env.WORKING_DIRECTORY;
71+
const manifestPath = path.join(directory, 'package.json');
72+
const manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf8'));
73+
manifest.version = '1.2.3';
74+
manifest.files = ['dist'];
75+
manifest.scripts = Object.fromEntries(['preinstall', 'install', 'postinstall', 'preversion', 'version', 'postversion', 'prepare', 'prepack', 'postpack'].map(name => [name, 'exit 91']));
76+
manifest.devDependencies = { 'must-not-install': 'file:./missing' };
77+
fs.writeFileSync(manifestPath, JSON.stringify(manifest));
78+
if (manifest.packageManager) fs.writeFileSync(path.join(directory, 'yarn.lock'), '# Conflicting lockfile: packageManager takes precedence.\n');
79+
await io.mkdirP(path.join(directory, 'dist'));
80+
fs.writeFileSync(path.join(directory, 'dist/prepared.txt'), 'prepared before packaging\n');
81+
82+
- name: Act - Reject an invalid artifact ID
83+
id: invalid-artifact
84+
continue-on-error: true
85+
uses: $/actions/package/create
86+
with:
87+
working-directory: ${{ matrix.working-directory }}
88+
build-artifact-id: "0"
89+
- name: Assert - Reject the artifact before packaging
90+
env:
91+
OUTCOME: ${{ steps.invalid-artifact.outcome }}
92+
run: test "$OUTCOME" = failure
93+
94+
- name: Act - Run "package/create" action
3795
id: act-package
38-
uses: $/actions/package
96+
uses: $/actions/package/create
3997
with:
4098
working-directory: ${{ matrix.working-directory }}
4199
artifact-name: package-tarball-${{ github.job }}-${{ matrix.artifact-suffix }}-${{ github.run_id }}-${{ github.run_attempt }}
42100

43-
- name: Assert - Check "package" outputs
101+
- name: Assert - Check "package/create" outputs
44102
env:
45103
PACKAGE_TARBALL_PATH: ${{ steps.act-package.outputs.package-tarball-path }}
46104
PACKAGE_TARBALL_ARTIFACT_ID: ${{ steps.act-package.outputs.package-tarball-artifact-id }}
@@ -60,6 +118,26 @@ jobs:
60118
exit 1
61119
fi
62120
121+
- name: Assert - Preserve prepared files and the source version
122+
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
123+
env:
124+
WORKING_DIRECTORY: ${{ matrix.working-directory }}
125+
TARBALL: ${{ steps.act-package.outputs.package-tarball-path }}
126+
with:
127+
script: |
128+
const assert = require('node:assert/strict');
129+
const fs = require('node:fs');
130+
const path = require('node:path');
131+
const directory = process.env.WORKING_DIRECTORY;
132+
assert.match(fs.readFileSync(process.env.PACK_COMMAND_LOG, 'utf8'), /^pack /m);
133+
const { stdout: contents } = await exec.getExecOutput('tar', ['-xOf', process.env.TARBALL, 'package/dist/prepared.txt']);
134+
const { stdout: manifest } = await exec.getExecOutput('tar', ['-xOf', process.env.TARBALL, 'package/package.json']);
135+
assert.equal(contents, 'prepared before packaging\n');
136+
assert.equal(fs.readFileSync(path.join(directory, 'dist/prepared.txt'), 'utf8'), contents);
137+
assert.equal(JSON.parse(manifest).version, '1.2.3');
138+
assert.equal(JSON.parse(fs.readFileSync(path.join(directory, 'package.json'), 'utf8')).version, '1.2.3');
139+
assert.equal(fs.existsSync(path.join(directory, 'node_modules')), false);
140+
63141
- id: package-tarball-artifact
64142
name: Arrange - Export package tarball artifact ID
65143
env:
@@ -78,19 +156,19 @@ jobs:
78156
include:
79157
- working-directory: tests/npm
80158
artifact-suffix: npm
81-
install-command: npm install --force --legacy-peer-deps --no-audit --no-fund --loglevel=warn
159+
install-command: npm install --ignore-scripts --force --legacy-peer-deps --no-audit --no-fund --loglevel=warn
82160
package-tarball-artifact-id: ${{ needs.test.outputs['package-tarball-artifact-id-npm'] }}
83161
- working-directory: tests/pnpm
84162
artifact-suffix: pnpm
85-
install-command: pnpm install
163+
install-command: pnpm install --ignore-scripts
86164
package-tarball-artifact-id: ${{ needs.test.outputs['package-tarball-artifact-id-pnpm'] }}
87165
- working-directory: tests/pnpm-package-manager
88166
artifact-suffix: pnpm-package-manager
89-
install-command: pnpm install
167+
install-command: pnpm install --ignore-scripts
90168
package-tarball-artifact-id: ${{ needs.test.outputs['package-tarball-artifact-id-pnpm-package-manager'] }}
91169
- working-directory: tests/yarn
92170
artifact-suffix: yarn
93-
install-command: yarn add
171+
install-command: yarn add --ignore-scripts
94172
package-tarball-artifact-id: ${{ needs.test.outputs['package-tarball-artifact-id-yarn'] }}
95173
steps:
96174
- name: Arrange - Checkout sources
@@ -99,14 +177,15 @@ jobs:
99177
persist-credentials: false
100178

101179
- name: Arrange - Configure Node.js version
102-
run: echo "lts/*" > .nvmrc
180+
run: cp "$GITHUB_WORKSPACE/.node-version" .nvmrc
103181
working-directory: ${{ matrix.working-directory }}
104182

105183
- name: Arrange - Setup Node.js runtime
106184
id: arrange-setup-node
107185
uses: $/actions/setup-node
108186
with:
109187
working-directory: ${{ matrix.working-directory }}
188+
install-dependencies: "false"
110189

111190
- name: Assert - Check package tarball artifact ID
112191
env:

0 commit comments

Comments
 (0)