@cycjimmy/semantic-release-action 5.0.0 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -18,16 +18,16 @@ GitHub Action for [Semantic Release][semantic-url].
18
18
  ```yaml
19
19
  steps:
20
20
  - name: Checkout
21
- uses: actions/checkout@v4
21
+ uses: actions/checkout@v5
22
22
  - name: Semantic Release
23
- uses: cycjimmy/semantic-release-action@v4
23
+ uses: cycjimmy/semantic-release-action@v5
24
24
  env:
25
25
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26
26
  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
27
27
  ```
28
28
 
29
29
  **IMPORTANT**: `GITHUB_TOKEN` does not have the required permissions to operate on protected branches.
30
- If you are using this action for protected branches, replace `GITHUB_TOKEN` with [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). If using the `@semantic-release/git` plugin for protected branches, avoid persisting credentials as part of `actions/checkout@v4` by setting the parameter `persist-credentials: false`. This credential does not have the required permission to operate on protected branches.
30
+ If you are using this action for protected branches, replace `GITHUB_TOKEN` with [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). If using the `@semantic-release/git` plugin for protected branches, avoid persisting credentials as part of `actions/checkout@v5` by setting the parameter `persist-credentials: false`. This credential does not have the required permission to operate on protected branches.
31
31
 
32
32
  #### Private Packages
33
33
 
@@ -63,9 +63,9 @@ then make sure that you configure this in your `package.json` file:
63
63
  ```yaml
64
64
  steps:
65
65
  - name: Checkout
66
- uses: actions/checkout@v4
66
+ uses: actions/checkout@v5
67
67
  - name: Semantic Release
68
- uses: cycjimmy/semantic-release-action@v4
68
+ uses: cycjimmy/semantic-release-action@v5
69
69
  with:
70
70
  semantic_version: 19.0.5 # It is recommended to specify a version range
71
71
  # for semantic-release when using
@@ -75,7 +75,7 @@ steps:
75
75
  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
76
76
  ```
77
77
 
78
- If no version range is specified with `cycjimmy/semantic-release-action@v4` then [semantic-release](https://github.com/semantic-release/semantic-release/) version [21.1.1](https://github.com/semantic-release/semantic-release/releases/tag/v21.1.1) is used.
78
+ If no version range is specified with `cycjimmy/semantic-release-action@v5` then [semantic-release](https://github.com/semantic-release/semantic-release/) version [24.2.7](https://github.com/semantic-release/semantic-release/releases/tag/v24.2.7) is used.
79
79
 
80
80
  #### branches
81
81
  > {Optional Input Parameter} The branches on which releases should happen.<br>`branches` supports for **semantic-release above v16**.
@@ -83,9 +83,9 @@ If no version range is specified with `cycjimmy/semantic-release-action@v4` then
83
83
  ```yaml
84
84
  steps:
85
85
  - name: Checkout
86
- uses: actions/checkout@v4
86
+ uses: actions/checkout@v5
87
87
  - name: Semantic Release
88
- uses: cycjimmy/semantic-release-action@v4
88
+ uses: cycjimmy/semantic-release-action@v5
89
89
  with:
90
90
  semantic_version: 16
91
91
  # you can set branches for semantic-release above v16.
@@ -129,9 +129,9 @@ See [configuration#branches](https://semantic-release.gitbook.io/semantic-releas
129
129
  ```yaml
130
130
  steps:
131
131
  - name: Checkout
132
- uses: actions/checkout@v4
132
+ uses: actions/checkout@v5
133
133
  - name: Semantic Release
134
- uses: cycjimmy/semantic-release-action@v4
134
+ uses: cycjimmy/semantic-release-action@v5
135
135
  with:
136
136
  semantic_version: 15.13.28
137
137
  # you can set branch for semantic-release older than v16.
@@ -154,9 +154,9 @@ Github Action Workflow:
154
154
  ```yaml
155
155
  steps:
156
156
  - name: Checkout
157
- uses: actions/checkout@v4
157
+ uses: actions/checkout@v5
158
158
  - name: Semantic Release
159
- uses: cycjimmy/semantic-release-action@v4
159
+ uses: cycjimmy/semantic-release-action@v5
160
160
  with:
161
161
  # You can specify specifying version range for the extra plugins if you prefer.
162
162
  extra_plugins: |
@@ -184,9 +184,9 @@ Release Config:
184
184
  ```yaml
185
185
  steps:
186
186
  - name: Checkout
187
- uses: actions/checkout@v4
187
+ uses: actions/checkout@v5
188
188
  - name: Semantic Release
189
- uses: cycjimmy/semantic-release-action@v4
189
+ uses: cycjimmy/semantic-release-action@v5
190
190
  with:
191
191
  dry_run: true
192
192
  env:
@@ -200,9 +200,9 @@ steps:
200
200
  ```yaml
201
201
  steps:
202
202
  - name: Checkout
203
- uses: actions/checkout@v4
203
+ uses: actions/checkout@v5
204
204
  - name: Semantic Release
205
- uses: cycjimmy/semantic-release-action@v4
205
+ uses: cycjimmy/semantic-release-action@v5
206
206
  with:
207
207
  ci: false
208
208
  env:
@@ -218,9 +218,9 @@ The action can be used with `extends` option to extend an existing [sharable con
218
218
  ```yaml
219
219
  steps:
220
220
  - name: Checkout
221
- uses: actions/checkout@v4
221
+ uses: actions/checkout@v5
222
222
  - name: Semantic Release
223
- uses: cycjimmy/semantic-release-action@v4
223
+ uses: cycjimmy/semantic-release-action@v5
224
224
  with:
225
225
  # You can extend an existing shareable configuration.
226
226
  # And you can specify version range for the shareable configuration if you prefer.
@@ -238,9 +238,9 @@ This action run semantic release in the github provided workspace by default. Yo
238
238
  ```yaml
239
239
  steps:
240
240
  - name: Checkout
241
- uses: actions/checkout@v4
241
+ uses: actions/checkout@v5
242
242
  - name: Semantic Release
243
- uses: cycjimmy/semantic-release-action@v4
243
+ uses: cycjimmy/semantic-release-action@v5
244
244
  with:
245
245
  # You can select another working directory like a subdirectory for example.
246
246
  working_directory: ./code
@@ -255,9 +255,9 @@ The default tag format on semantic-release is `v{version}`. You can override tha
255
255
  ```yaml
256
256
  steps:
257
257
  - name: Checkout
258
- uses: actions/checkout@v4
258
+ uses: actions/checkout@v5
259
259
  - name: Semantic Release
260
- uses: cycjimmy/semantic-release-action@v4
260
+ uses: cycjimmy/semantic-release-action@v5
261
261
  with:
262
262
  tag_format: custom-v${version}
263
263
  env:
@@ -271,7 +271,7 @@ Setting this to true will unset the `GITHUB_ACTIONS` environment variable. This
271
271
  ```yaml
272
272
  steps:
273
273
  - name: Checkout
274
- uses: actions/checkout@v4
274
+ uses: actions/checkout@v5
275
275
  - name: Temporarily merge PR branch
276
276
  if: ${{ github.event_name == 'pull_request' }}
277
277
  run: |
@@ -279,7 +279,7 @@ steps:
279
279
  git config --global user.email github-actions@github.com
280
280
  git merge --no-ff origin/${{ github.event.pull_request.head.ref }} --message "${{ github.event.pull_request.title }}"
281
281
  - name: Semantic Release
282
- uses: cycjimmy/semantic-release-action@v4
282
+ uses: cycjimmy/semantic-release-action@v5
283
283
  with:
284
284
  unset_gha_env: ${{ github.event_name == 'pull_request' }}
285
285
  ci: ${{ github.event_name == 'pull_request' && false || '' }}
@@ -308,9 +308,9 @@ steps:
308
308
  ```yaml
309
309
  steps:
310
310
  - name: Checkout
311
- uses: actions/checkout@v4
311
+ uses: actions/checkout@v5
312
312
  - name: Semantic Release
313
- uses: cycjimmy/semantic-release-action@v4
313
+ uses: cycjimmy/semantic-release-action@v5
314
314
  id: semantic # Need an `id` for output variables
315
315
  env:
316
316
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
package/docs/CHANGELOG.md CHANGED
@@ -1,3 +1,10 @@
1
+ ## [5.0.1](https://github.com/cycjimmy/semantic-release-action/compare/v5.0.0...v5.0.1) (2025-10-09)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * improves result handling in windUpJob.task.js ([4267eee](https://github.com/cycjimmy/semantic-release-action/commit/4267eee56034cc3ee6f2fef9bdc3cc125ca073db))
7
+
1
8
  # [5.0.0](https://github.com/cycjimmy/semantic-release-action/compare/v4.2.2...v5.0.0) (2025-08-30)
2
9
 
3
10
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cycjimmy/semantic-release-action",
3
- "version": "5.0.0",
3
+ "version": "5.0.1",
4
4
  "description": "GitHub Action for Semantic Release",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -26,6 +26,6 @@
26
26
  "@cycjimmy/awesome-js-funcs": "^4.0.9",
27
27
  "@semantic-release/changelog": "^6.0.3",
28
28
  "@semantic-release/git": "^10.0.1",
29
- "semantic-release": "^24.2.7"
29
+ "semantic-release": "^24.2.9"
30
30
  }
31
31
  }
@@ -7,14 +7,20 @@ const outputs = require('./outputs.json');
7
7
  * @returns {Promise<void>}
8
8
  */
9
9
  module.exports = async (result) => {
10
- if (!result) {
10
+ const resolved = await result;
11
+ if (!resolved) {
11
12
  core.debug('No release published.');
12
- return Promise.resolve();
13
+ return;
13
14
  }
14
15
 
15
- const {lastRelease, commits, nextRelease, releases} = await result;
16
+ const {
17
+ lastRelease = {},
18
+ commits = [],
19
+ nextRelease = {},
20
+ releases = [],
21
+ } = resolved;
16
22
 
17
- if (lastRelease.version) {
23
+ if (lastRelease?.version) {
18
24
  core.debug(`The last release was "${lastRelease.version}".`);
19
25
  core.setOutput(outputs.last_release_version, lastRelease.version);
20
26
  core.setOutput(outputs.last_release_git_head, lastRelease.gitHead);
@@ -23,7 +29,7 @@ module.exports = async (result) => {
23
29
 
24
30
  if (!nextRelease) {
25
31
  core.debug('No release published.');
26
- return Promise.resolve();
32
+ return;
27
33
  }
28
34
 
29
35
  core.debug(`Published ${nextRelease.type} release version ${nextRelease.version} containing ${commits.length} commits.`);