Skip to content

Commit 6a759b5

Browse files
committed
Improve docs of release workflow
1 parent fb044b7 commit 6a759b5

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

.github/workflows/pr-labeler.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ jobs:
88
pr-labeler:
99
runs-on: ubuntu-18.04
1010
steps:
11-
- uses: TimonVS/pr-labeler-action@v3
11+
- uses: TimonVS/pr-labeler-action@v3.1.0
1212
env:
1313
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-management.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141

4242
- name: Check package.json for version change
4343
id: check_package_version
44-
uses: EndBug/version-check@v1
44+
uses: EndBug/version-check@v1.6.0
4545

4646
- name: Log when version changed
4747
if: steps.check_package_version.outputs.changed == 'true'
@@ -63,7 +63,7 @@ jobs:
6363
runs-on: ubuntu-18.04
6464
steps:
6565
- name: Draft release on GitHub
66-
uses: release-drafter/release-drafter@v5
66+
uses: release-drafter/release-drafter@v5.12.1
6767
env:
6868
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6969

@@ -80,7 +80,7 @@ jobs:
8080
# `build_and_test` job first so this job is skipped rather than exited with an error.
8181
- name: Publish matching GitHub release draft
8282
id: github_release
83-
uses: JamesMGreene/node-draft-releaser@v1
83+
uses: JamesMGreene/node-draft-releaser@v1.1.2
8484
env:
8585
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
8686

@@ -139,7 +139,7 @@ jobs:
139139
name: docs
140140

141141
- name: Deploy docs to GitHub Pages
142-
uses: JamesIves/github-pages-deploy-action@3.6.2
142+
uses: JamesIves/github-pages-deploy-action@3.7.1
143143
with:
144144
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
145145
FOLDER: docs # Must match the name of the artifact used.

RELEASING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,9 @@ See the source of `.github/workflows` for details.
5353
overwritten. Save your changes in release draft with the _Save draft_
5454
button, **do not publish** yet!
5555

56-
3. Get back to the repository, commit both files as `Bump version` in
57-
`release/<VERSION_NUMBER>` branch, create a pull request, and merge it.
56+
3. Get back to the repository, commit both files as
57+
`Bump version to <VERSION_NUMBER>` in `release/<VERSION_NUMBER>` branch,
58+
create a pull request, hold your breath, and—merge it.
5859

5960
3. **Automatic:** once the release pull request from step 2.3 is merged, the
6061
following actions are triggered automatically:
@@ -64,3 +65,6 @@ See the source of `.github/workflows` for details.
6465
2. Git tag with the version number from step 2 is added to `master` branch.
6566
3. Package is built and published to npm package registry.
6667
4. Documentation is built and deployed to production.
68+
69+
**Note:** prefix version number with `v` everywhere except in `package.json` and
70+
`package-lock.json`.

0 commit comments

Comments
 (0)