Skip to content

Commit 200ef14

Browse files
Brian M HuntBrian M Hunt
authored andcommitted
Clarify trusted publishing release docs
1 parent bd961ee commit 200ef14

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

.github/workflows/release.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Automated release via Changesets.
22
#
33
# On push to main:
4-
# - If there are unreleased changesets, opens/updates a "Version Packages"
4+
# - If there are unreleased changesets, opens/updates a release version
55
# PR that bumps versions and updates changelogs.
66
# - If there are no unreleased changesets, builds, tests, and publishes
77
# to npm from a separate least-privilege job.
@@ -30,9 +30,11 @@ jobs:
3030

3131
steps:
3232
- name: Checkout code
33+
# actions/checkout v6.0.2
3334
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
3435

3536
- name: Setup Node.js
37+
# actions/setup-node v6.3.0
3638
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f
3739
with:
3840
# npm trusted publishing requires npm CLI 11.5.1+, which is available
@@ -46,6 +48,7 @@ jobs:
4648

4749
- name: Create or update version PR
4850
id: changesets
51+
# changesets/action v1.5.3
4952
uses: changesets/action@e0145edc7d9d8679003495b11f87bd8ef63c0cba
5053
with:
5154
version: npx changeset version
@@ -69,9 +72,11 @@ jobs:
6972

7073
steps:
7174
- name: Checkout code
75+
# actions/checkout v6.0.2
7276
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
7377

7478
- name: Setup Node.js
79+
# actions/setup-node v6.3.0
7580
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f
7681
with:
7782
# npm trusted publishing requires npm CLI 11.5.1+, which is available

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ It's available as `@tko/build.knockout`, and over CDN:
5555
| $ `make test` | Run all tests with electron. See below. |
5656
| $ `make test-headless` | Run all tests with chromium. See below. |
5757
| $ `npx changeset add` | Add a changeset for package behavior changes in your PR |
58-
| $ `Release workflow` | On merge to `main`, CI opens or updates a version PR and publishes from GitHub Actions via npm trusted publishing |
58+
| Release workflow | On merge to `main`, CI opens or updates a version PR; when that version PR is merged and there are no remaining changesets, CI publishes from GitHub Actions via npm trusted publishing |
5959
| $ `make test-coverage` | Run all tests and create a code coverage report |
6060

6161
Checkout the `Makefile` for more commands that can be executed with `make {command}`.

0 commit comments

Comments
 (0)