@github-actions-workflow-ts/actions 2.4.0 → 2.5.0-beta.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 +26 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -194,6 +194,32 @@ Add to `wac.config.json`:
194
194
  | softprops/action-gh-release | `SoftpropsActionGhReleaseV1`, `SoftpropsActionGhReleaseV2` | [GitHub](https://github.com/softprops/action-gh-release) |
195
195
  <!-- GENERATED-ACTIONS-TABLE:END -->
196
196
 
197
+ ## Diagnostics
198
+
199
+ ### `action-version-unverifiable`
200
+
201
+ **severity:** ⚠️ warning
202
+
203
+ The action version provided cannot be verified. This may be for any of the following reasons:
204
+
205
+ - The repository specifier is different to the expected specifier. This may be due to a mistake in your workflow, or you may be using a fork of the repository. In the latter case, the semver version cannot be validated because the fork may not follow the same versioning as the upstream repository.
206
+
207
+ - The git reference is not a valid semver version. This may be due to a mistake in your workflow, or you may be using a commit SHA, branch name, or other git reference which is not a semver specifier.
208
+
209
+ If you see this warning then there is no guarantee that the TypeScript types for the actions inputs and outputs are valid for the action version you are using.
210
+
211
+ ### `action-version-semver-violation`
212
+
213
+ **severity:** ⚠️ warning
214
+
215
+ The version of the action you are using does not satisfy the semver constraints required by the action. You may be seeing this warning for any of the following reasons:
216
+
217
+ - You have mistakenly specified the wrong semantic version tag.
218
+ - You have intentionally specified a different semantic version tag.
219
+ - You have recently updated `@github-actions-workflow-ts/actions` to a new version, and a new version of the action was published to GitHub.
220
+
221
+ If you see this warning then there is no guarantee that the TypeScript types for the actions inputs and outputs are valid for the action version you are using.
222
+
197
223
  # Development
198
224
  ## Regenerating Types
199
225
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@github-actions-workflow-ts/actions",
3
- "version": "2.4.0",
3
+ "version": "2.5.0-beta.2",
4
4
  "description": "Typed wrappers for popular GitHub Actions",
5
5
  "author": "Emmanuel N Kyeyune",
6
6
  "license": "MIT",
@@ -29,7 +29,7 @@
29
29
  "dist"
30
30
  ],
31
31
  "dependencies": {
32
- "@github-actions-workflow-ts/lib": "2.4.0"
32
+ "@github-actions-workflow-ts/lib": "2.5.0-beta.2"
33
33
  },
34
34
  "devDependencies": {
35
35
  "@types/js-yaml": "^4.0.9",