Skip to content

Commit 3f02348

Browse files
AlanGreeneAlanGreene
committed
Add workflow to publish npm packages
Add workflow to handle automatically publishing packages to the npm registry when the commit message matches the expected format: `Publish <version> of the @tektoncd/dashboard-* packages` For PRs it validates the PR is up-to-date with the base branch and that the PR title and commit message match. For both PRs and pushes it validates that the version in the commit message matches the version in the package.json files. Once all validation passes, it will publish the package (dry-run for PR). This simplifies the process of releases new package versions as now it only requires running the `npm version --workspaces <version>` command and committing the result. The rest of the process, i.e. ensuring inter-workspace dependencies are updated to use the correct versions before publishing, is handled by the workflow. Also generate provenance statements for the packages.
1 parent 3f56be4 commit 3f02348

File tree

6 files changed

+122
-18
lines changed

6 files changed

+122
-18
lines changed

‎.github/workflows/publish.yml

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
name: Publish NPM packages
2+
3+
on:
4+
pull_request:
5+
branches: ["main"]
6+
paths-ignore:
7+
- "**"
8+
- "!**/package.json"
9+
- "!**/package-lock.json"
10+
types:
11+
- opened
12+
- reopened
13+
- synchronize
14+
push:
15+
branches: ["main"]
16+
paths-ignore:
17+
- "**"
18+
- "!**/package.json"
19+
- "!**/package-lock.json"
20+
21+
defaults:
22+
run:
23+
shell: bash
24+
25+
jobs:
26+
publish:
27+
if: >-
28+
${{
29+
(
30+
github.event_name == 'pull_request' &&
31+
startsWith(github.event.pull_request.title, 'Publish v') &&
32+
endsWith(github.event.pull_request.title, 'of the @tektoncd/dashboard-* packages')
33+
) ||
34+
(
35+
github.event_name == 'push' &&
36+
startsWith(github.event.head_commit.message, 'Publish v') &&
37+
endsWith(github.event.head_commit.message, 'of the @tektoncd/dashboard-* packages')
38+
)
39+
}}
40+
runs-on: ubuntu-24.04
41+
permissions:
42+
contents: read
43+
# required for npm package provenance
44+
id-token: write
45+
steps:
46+
- name: Harden Runner
47+
uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
48+
with:
49+
egress-policy: audit
50+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
51+
with:
52+
# for PRs checkout the head rather than the merge commit so we can get the original commit message
53+
ref: ${{ github.event.pull_request.head.sha || github.sha }}
54+
- name: Validate PR title and commit message match
55+
if: ${{ github.event_name == 'pull_request' }}
56+
run: |
57+
PR_TITLE="${{ github.event.pull_request.title }}"
58+
COMMIT_MESSAGE="$(git log --pretty=%s -n 1)"
59+
if [ "$PR_TITLE" != "$COMMIT_MESSAGE" ]; then
60+
echo "::error::PR title and commit message mismatch"
61+
echo "Expected format: Publish <version> of the @tektoncd/dashboard-* packages"
62+
echo "PR_TITLE: $PR_TITLE"
63+
echo "COMMIT_MESSAGE: $COMMIT_MESSAGE"
64+
exit 1
65+
else
66+
echo "PR title and commit message match, continuing…"
67+
fi
68+
- name: Get version
69+
id: get-version
70+
run: |
71+
echo "Extracting version from commit message"
72+
VERSION=$(echo ${{ github.event.pull_request.title || github.event.head_commit.message }} | grep -Po '(v\d+\.\d+\.\d+(\S)*)')
73+
echo "VERSION: $VERSION"
74+
echo "newPackageVersion=${VERSION}" >> $GITHUB_OUTPUT
75+
- name: Check version matches package.json
76+
run: |
77+
EXPECTED_VERSION="${{ steps.get-version.outputs.newPackageVersion }}"
78+
mismatch=false
79+
for packageJson in ./packages/*/package.json; do
80+
VERSION="v$(jq -r .version $packageJson)"
81+
PRIVATE="$(jq -r .private)"
82+
if [ "$PRIVATE" == "false" ] && [ "$VERSION" != "$EXPECTED_VERSION" ]; then
83+
echo "::error::Version mismatch found in $packageJson: ${VERSION}"
84+
mismatch=true
85+
fi
86+
done
87+
if [ "$mismatch" == "true" ]; then
88+
exit 1
89+
fi
90+
- name: Check PR is up-to-date
91+
if: ${{ github.event_name == 'pull_request' }}
92+
env:
93+
GH_TOKEN: ${{ github.token }}
94+
run: |
95+
BASE_REF="${{github.event.pull_request.base.repo.owner.login}}:${{github.event.pull_request.base.ref}}"
96+
HEAD_REF="${{github.event.pull_request.head.repo.owner.login}}:${{github.event.pull_request.head.ref}}"
97+
STATUS=$(gh api \
98+
-H "Accept: application/vnd.github+json" \
99+
-H "X-GitHub-Api-Version: 2022-11-28" \
100+
/repos/${{ github.repository }}/compare/${BASE_REF}...${HEAD_REF} | jq -r .status)
101+
if [ "$STATUS" != "ahead" ]; then
102+
echo "::error::Pull request not up-to-date with base branch, please rebase"
103+
exit 1
104+
else
105+
echo "Pull request is up-to-date with base branch, continuing…"
106+
fi
107+
- uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
108+
with:
109+
node-version-file: .nvmrc
110+
- name: Publish dry run
111+
if: ${{ github.event_name == 'pull_request' }}
112+
run: npm publish --workspaces --provenance --access public --dry-run
113+
- name: Publish
114+
if: ${{ github.event_name == 'push' }}
115+
run: npm publish --workspaces --provenance --access public
116+
# env:
117+
# NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

‎package-lock.json

-13
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/components/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"main": "./src/components/index.js",
1616
"type": "module",
1717
"scripts": {
18-
"version": "npm pkg set \"dependencies.@tektoncd/dashboard-utils=$npm_new_version\"",
18+
"prepublishOnly": "npm pkg set \"dependencies.@tektoncd/dashboard-utils=$npm_package_version\"",
1919
"postpublish": "npm pkg set \"dependencies.@tektoncd/dashboard-utils=file:../utils\""
2020
},
2121
"dependencies": {

‎packages/e2e/package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/e2e/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@tektoncd/dashboard-e2e",
3-
"version": "0.52.0-alpha.1",
3+
"version": "0.0.0",
44
"author": {
55
"name": "The Tekton Authors"
66
},

‎packages/graph/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"main": "./src/index.js",
1818
"type": "module",
1919
"scripts": {
20-
"version": "npm pkg set \"dependencies.@tektoncd/dashboard-utils=$npm_new_version\"",
20+
"prepublishOnly": "npm pkg set \"dependencies.@tektoncd/dashboard-utils=$npm_package_version\"",
2121
"postpublish": "npm pkg set \"dependencies.@tektoncd/dashboard-utils=file:../utils\""
2222
},
2323
"dependencies": {

0 commit comments

Comments
 (0)