node-package-release-action 2.1.0 → 2.1.2

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.
Files changed (2) hide show
  1. package/README.md +20 -1
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -71,7 +71,7 @@ This controls whether the GitHub Release should be marked as a prerelease. The d
71
71
 
72
72
  ### `skip-if-no-diff`
73
73
 
74
- The controls whether this action should do nothing if there's no changes since last release of the same release type. If we release a minor upgrade to `1.2.3` or `1.2.3-4` it should be `1.2.4`. If `1.2.4` and `1.2.3` are the same and if `skip-if-no-diff` is set to `true`, `1.2.4` won't be created. `1.2.3-*` won't be used in the comparison. The default value is `false`.
74
+ This controls whether this action should do nothing if there's no changes since last release of the same release type. If we release a minor upgrade to `1.2.3` or `1.2.4-0` it should be `1.2.4`. If `1.2.4` and `1.2.3` are the same and if `skip-if-no-diff` is set to `true`, `1.2.4` won't be created. `1.2.4-*` won't be used in the comparison. The default value is `false`.
75
75
 
76
76
  ### `diff-targets`
77
77
 
@@ -160,3 +160,22 @@ on:
160
160
  ### How do I know if `skip-if-no-diff` took effect?
161
161
 
162
162
  Use an output called `skipped`. See the first code example as a reference.
163
+
164
+ ### What does "last release of the same release type" mean for `skip-if-no-diff`?
165
+
166
+ Let's say these are the releases returned from `git tag`:
167
+
168
+ - `v1.0.0`
169
+ - `v1.1.0`
170
+ - `v1.2.0`
171
+ - `v1.2.1`
172
+ - `v1.2.2`
173
+ - `v1.2.3`
174
+ - `v1.2.4-0`
175
+ - `v1.2.4-1`
176
+
177
+ We are going to make a patch release. The release version will be `1.2.4`. `1.2.4`'s last release of the same type (patch) is `1.2.3`.
178
+
179
+ Before `1.2.3` there is `1.2.2`, but `1.2.2` + `patch` doesn't equal to `1.2.4`. `1.2.2` isn't the last release of the same release type.
180
+
181
+ After `1.2.3` there is `1.2.4-0` and `1.2.4-0` + `patch` equals to `1.2.4`. However, we should pick `1.2.3`. If there's any diff since `1.2.3` we should make the `1.2.4` release. When we say "release `1.2.4` as a patch if this patch contains any change", we mean changes since `1.2.3`. Even if there's no change since `1.2.4-0` we should still make the release. That's because `1.2.4-0` as a prepatch release may already contains all the changes we want so there's no change since `1.2.4-0`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "node-package-release-action",
3
- "version": "2.1.0",
3
+ "version": "2.1.2",
4
4
  "description": "A template to create custom GitHub Action with TypeScript/JavaScript.",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.js",
@@ -37,15 +37,15 @@
37
37
  "eslint-config-prettier": "^9.0.0",
38
38
  "eslint-plugin-prettier": "5",
39
39
  "husky": "^8.0.2",
40
- "lint-staged": "^14.0.0",
40
+ "lint-staged": "^15.0.2",
41
41
  "prettier": "^3.0.2",
42
42
  "typescript": "^5.0.2"
43
43
  },
44
44
  "dependencies": {
45
45
  "@actions/core": "^1.10.0",
46
46
  "@actions/exec": "^1.1.1",
47
- "@actions/github": "^5.1.1",
48
- "@octokit/plugin-retry": "^4.0.3",
47
+ "@actions/github": "^6.0.0",
48
+ "@octokit/plugin-retry": "^6.0.1",
49
49
  "@octokit/plugin-throttling": "^5.0.1",
50
50
  "glob": "^10.2.3",
51
51
  "semver": "^7.3.8"