@github-actions-workflow-ts/lib 2.2.0 → 2.4.0-beta.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.
Files changed (39) hide show
  1. package/dist/cjs/job/index.d.ts +28 -0
  2. package/dist/cjs/job/index.d.ts.map +1 -1
  3. package/dist/cjs/job/index.js +28 -0
  4. package/dist/cjs/job/index.js.map +1 -1
  5. package/dist/cjs/step/index.d.ts +15 -0
  6. package/dist/cjs/step/index.d.ts.map +1 -1
  7. package/dist/cjs/step/index.js +15 -0
  8. package/dist/cjs/step/index.js.map +1 -1
  9. package/dist/cjs/types/githubActionsWorkflow.d.ts +120 -263
  10. package/dist/cjs/types/githubActionsWorkflow.d.ts.map +1 -1
  11. package/dist/cjs/types/index.d.ts +15 -0
  12. package/dist/cjs/types/index.d.ts.map +1 -1
  13. package/dist/cjs/types/index.js +15 -0
  14. package/dist/cjs/types/index.js.map +1 -1
  15. package/dist/cjs/workflow/index.d.ts +42 -1
  16. package/dist/cjs/workflow/index.d.ts.map +1 -1
  17. package/dist/cjs/workflow/index.js +31 -1
  18. package/dist/cjs/workflow/index.js.map +1 -1
  19. package/dist/esm/job/index.d.ts +28 -0
  20. package/dist/esm/job/index.d.ts.map +1 -1
  21. package/dist/esm/job/index.js +28 -0
  22. package/dist/esm/job/index.js.map +1 -1
  23. package/dist/esm/step/index.d.ts +15 -0
  24. package/dist/esm/step/index.d.ts.map +1 -1
  25. package/dist/esm/step/index.js +15 -0
  26. package/dist/esm/step/index.js.map +1 -1
  27. package/dist/esm/types/githubActionsWorkflow.d.ts +120 -263
  28. package/dist/esm/types/githubActionsWorkflow.d.ts.map +1 -1
  29. package/dist/esm/types/index.d.ts +15 -0
  30. package/dist/esm/types/index.d.ts.map +1 -1
  31. package/dist/esm/types/index.js +15 -0
  32. package/dist/esm/types/index.js.map +1 -1
  33. package/dist/esm/workflow/index.d.ts +42 -1
  34. package/dist/esm/workflow/index.d.ts.map +1 -1
  35. package/dist/esm/workflow/index.js +31 -1
  36. package/dist/esm/workflow/index.js.map +1 -1
  37. package/dist/tsconfig.cjs.tsbuildinfo +1 -1
  38. package/dist/tsconfig.esm.tsbuildinfo +1 -1
  39. package/package.json +1 -1
@@ -7,190 +7,134 @@ export type Event = 'branch_protection_rule' | 'check_run' | 'check_suite' | 'cr
7
7
  /**
8
8
  * Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event.
9
9
  */
10
- export type EventObject = {
11
- types?: Types;
10
+ export type BranchProtectionRuleEvent = {
12
11
  [k: string]: unknown;
13
- } & ({
14
- [k: string]: unknown;
15
- } | null);
16
- /**
17
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
18
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
19
- */
20
- export type Types = ([unknown, ...unknown[]] | string) & ('created' | 'edited' | 'deleted')[];
12
+ } | null;
21
13
  /**
22
14
  * Runs your workflow anytime the check_run event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/runs.
23
15
  */
24
- export type EventObject1 = {
25
- types?: Types1;
26
- [k: string]: unknown;
27
- } & ({
16
+ export type CheckRunEvent = {
28
17
  [k: string]: unknown;
29
- } | null);
30
- /**
31
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
32
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
33
- */
34
- export type Types1 = ([unknown, ...unknown[]] | string) & ('created' | 'rerequested' | 'completed' | 'requested_action')[];
18
+ } | null;
35
19
  /**
36
20
  * Runs your workflow anytime the check_suite event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/suites/.
37
21
  */
38
- export type EventObject2 = {
39
- types?: Types2;
22
+ export type CheckSuiteEvent = {
40
23
  [k: string]: unknown;
41
- } & ({
24
+ } | null;
25
+ /**
26
+ * Runs your workflow anytime someone creates a branch or tag, which triggers the create event. For information about the REST API, see https://developer.github.com/v3/git/refs/#create-a-reference.
27
+ */
28
+ export type CreateEvent = {
42
29
  [k: string]: unknown;
43
- } | null);
30
+ } | null;
44
31
  /**
45
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
46
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
32
+ * Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. For information about the REST API, see https://developer.github.com/v3/git/refs/#delete-a-reference.
47
33
  */
48
- export type Types2 = ([unknown, ...unknown[]] | string) & ('completed' | 'requested' | 'rerequested')[];
34
+ export type DeleteEvent = {
35
+ [k: string]: unknown;
36
+ } | null;
49
37
  /**
50
- * Runs your workflow anytime the discussion event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions
38
+ * Runs your workflow anytime someone creates a deployment, which triggers the deployment event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/.
51
39
  */
52
- export type EventObject3 = {
53
- types?: Types3;
40
+ export type DeploymentEvent = {
54
41
  [k: string]: unknown;
55
- } & ({
42
+ } | null;
43
+ /**
44
+ * Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status.
45
+ */
46
+ export type DeploymentStatusEvent = {
56
47
  [k: string]: unknown;
57
- } | null);
48
+ } | null;
58
49
  /**
59
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
60
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
50
+ * Runs your workflow anytime the discussion event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions
61
51
  */
62
- export type Types3 = ([unknown, ...unknown[]] | string) & ('created' | 'edited' | 'deleted' | 'transferred' | 'pinned' | 'unpinned' | 'labeled' | 'unlabeled' | 'locked' | 'unlocked' | 'category_changed' | 'answered' | 'unanswered')[];
52
+ export type DiscussionEvent = {
53
+ [k: string]: unknown;
54
+ } | null;
63
55
  /**
64
56
  * Runs your workflow anytime the discussion_comment event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions
65
57
  */
66
- export type EventObject4 = {
67
- types?: Types4;
68
- [k: string]: unknown;
69
- } & ({
58
+ export type DiscussionCommentEvent = {
70
59
  [k: string]: unknown;
71
- } | null);
60
+ } | null;
72
61
  /**
73
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
74
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
62
+ * Runs your workflow anytime when someone forks a repository, which triggers the fork event. For information about the REST API, see https://developer.github.com/v3/repos/forks/#create-a-fork.
75
63
  */
76
- export type Types4 = ([unknown, ...unknown[]] | string) & ('created' | 'edited' | 'deleted')[];
64
+ export type ForkEvent = {
65
+ [k: string]: unknown;
66
+ } | null;
77
67
  /**
78
- * Runs your workflow anytime the issue_comment event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/comments/.
68
+ * Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.
79
69
  */
80
- export type EventObject5 = {
81
- types?: Types5;
70
+ export type GollumEvent = {
82
71
  [k: string]: unknown;
83
- } & ({
84
- [k: string]: unknown;
85
- } | null);
72
+ } | null;
86
73
  /**
87
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
88
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
74
+ * Runs your workflow anytime the issue_comment event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/comments/.
89
75
  */
90
- export type Types5 = ([unknown, ...unknown[]] | string) & ('created' | 'edited' | 'deleted')[];
76
+ export type IssueCommentEvent = {
77
+ [k: string]: unknown;
78
+ } | null;
91
79
  /**
92
80
  * Runs your workflow anytime the issues event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues.
93
81
  */
94
- export type EventObject6 = {
95
- types?: Types6;
82
+ export type IssuesEvent = {
96
83
  [k: string]: unknown;
97
- } & ({
98
- [k: string]: unknown;
99
- } | null);
100
- /**
101
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
102
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
103
- */
104
- export type Types6 = ([unknown, ...unknown[]] | string) & ('opened' | 'edited' | 'deleted' | 'transferred' | 'pinned' | 'unpinned' | 'closed' | 'reopened' | 'assigned' | 'unassigned' | 'labeled' | 'unlabeled' | 'locked' | 'unlocked' | 'milestoned' | 'demilestoned')[];
84
+ } | null;
105
85
  /**
106
86
  * Runs your workflow anytime the label event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/labels/.
107
87
  */
108
- export type EventObject7 = {
109
- types?: Types7;
110
- [k: string]: unknown;
111
- } & ({
88
+ export type LabelEvent = {
112
89
  [k: string]: unknown;
113
- } | null);
114
- /**
115
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
116
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
117
- */
118
- export type Types7 = ([unknown, ...unknown[]] | string) & ('created' | 'edited' | 'deleted')[];
90
+ } | null;
119
91
  /**
120
92
  * Runs your workflow when a pull request is added to a merge queue, which adds the pull request to a merge group. For information about the merge queue, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue .
121
93
  */
122
- export type EventObject8 = {
123
- types?: Types8;
94
+ export type MergeGroupEvent = {
124
95
  [k: string]: unknown;
125
- } & ({
126
- [k: string]: unknown;
127
- } | null);
128
- /**
129
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
130
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
131
- */
132
- export type Types8 = ([unknown, ...unknown[]] | string) & 'checks_requested'[];
96
+ } | null;
133
97
  /**
134
98
  * Runs your workflow anytime the milestone event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/milestones/.
135
99
  */
136
- export type EventObject9 = {
137
- types?: Types9;
100
+ export type MilestoneEvent = {
138
101
  [k: string]: unknown;
139
- } & ({
140
- [k: string]: unknown;
141
- } | null);
102
+ } | null;
142
103
  /**
143
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
144
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
104
+ * Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. For information about the REST API, see https://developer.github.com/v3/repos/pages/.
145
105
  */
146
- export type Types9 = ([unknown, ...unknown[]] | string) & ('created' | 'closed' | 'opened' | 'edited' | 'deleted')[];
106
+ export type PageBuildEvent = {
107
+ [k: string]: unknown;
108
+ } | null;
147
109
  /**
148
110
  * Runs your workflow anytime the project event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/.
149
111
  */
150
- export type EventObject10 = {
151
- types?: Types10;
152
- [k: string]: unknown;
153
- } & ({
112
+ export type ProjectEvent = {
154
113
  [k: string]: unknown;
155
- } | null);
156
- /**
157
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
158
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
159
- */
160
- export type Types10 = ([unknown, ...unknown[]] | string) & ('created' | 'updated' | 'closed' | 'reopened' | 'edited' | 'deleted')[];
114
+ } | null;
161
115
  /**
162
116
  * Runs your workflow anytime the project_card event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/cards.
163
117
  */
164
- export type EventObject11 = {
165
- types?: Types11;
118
+ export type ProjectCardEvent = {
166
119
  [k: string]: unknown;
167
- } & ({
168
- [k: string]: unknown;
169
- } | null);
170
- /**
171
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
172
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
173
- */
174
- export type Types11 = ([unknown, ...unknown[]] | string) & ('created' | 'moved' | 'converted' | 'edited' | 'deleted')[];
120
+ } | null;
175
121
  /**
176
122
  * Runs your workflow anytime the project_column event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/columns.
177
123
  */
178
- export type EventObject12 = {
179
- types?: Types12;
124
+ export type ProjectColumnEvent = {
180
125
  [k: string]: unknown;
181
- } & ({
182
- [k: string]: unknown;
183
- } | null);
126
+ } | null;
184
127
  /**
185
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
186
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
128
+ * Runs your workflow anytime someone makes a private repository public, which triggers the public event. For information about the REST API, see https://developer.github.com/v3/repos/#edit.
187
129
  */
188
- export type Types12 = ([unknown, ...unknown[]] | string) & ('created' | 'updated' | 'moved' | 'deleted')[];
130
+ export type PublicEvent = {
131
+ [k: string]: unknown;
132
+ } | null;
189
133
  /**
190
134
  * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
191
135
  * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
192
136
  */
193
- export type Types13 = ([unknown, ...unknown[]] | string) & ('assigned' | 'unassigned' | 'labeled' | 'unlabeled' | 'opened' | 'edited' | 'closed' | 'reopened' | 'synchronize' | 'converted_to_draft' | 'ready_for_review' | 'locked' | 'unlocked' | 'milestoned' | 'demilestoned' | 'review_requested' | 'review_request_removed' | 'auto_merge_enabled' | 'auto_merge_disabled' | 'enqueued' | 'dequeued')[];
137
+ export type PullRequestEventTypes = ([unknown, ...unknown[]] | string) & ('assigned' | 'unassigned' | 'labeled' | 'unlabeled' | 'opened' | 'edited' | 'closed' | 'reopened' | 'synchronize' | 'converted_to_draft' | 'ready_for_review' | 'locked' | 'unlocked' | 'milestoned' | 'demilestoned' | 'review_requested' | 'review_request_removed' | 'auto_merge_enabled' | 'auto_merge_disabled' | 'enqueued' | 'dequeued')[];
194
138
  /**
195
139
  * When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. If you only define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.
196
140
  * The branches, branches-ignore, tags, and tags-ignore keywords accept glob patterns that use the * and ** wildcard characters to match more than one branch or tag name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.
@@ -202,7 +146,6 @@ export type Types13 = ([unknown, ...unknown[]] | string) & ('assigned' | 'unassi
202
146
  * - A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.
203
147
  * - A matching positive pattern after a negative match will include the Git ref again.
204
148
  *
205
- * @minItems 1
206
149
  */
207
150
  export type Branch = [string, ...string[]];
208
151
  /**
@@ -212,7 +155,6 @@ export type Branch = [string, ...string[]];
212
155
  * - paths-ignore - Use the paths-ignore filter when you only need to exclude path names.
213
156
  * - paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.
214
157
  *
215
- * @minItems 1
216
158
  */
217
159
  export type Path = [string, ...string[]];
218
160
  /**
@@ -222,17 +164,9 @@ export type Path = [string, ...string[]];
222
164
  * Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.
223
165
  * The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.
224
166
  */
225
- export type EventObject13 = {
226
- types?: Types14;
227
- [k: string]: unknown;
228
- } & ({
167
+ export type PullRequestReviewEvent = {
229
168
  [k: string]: unknown;
230
- } | null);
231
- /**
232
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
233
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
234
- */
235
- export type Types14 = ([unknown, ...unknown[]] | string) & ('submitted' | 'edited' | 'dismissed')[];
169
+ } | null;
236
170
  /**
237
171
  * Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/comments.
238
172
  * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository.
@@ -240,50 +174,38 @@ export type Types14 = ([unknown, ...unknown[]] | string) & ('submitted' | 'edite
240
174
  * Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.
241
175
  * The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.
242
176
  */
243
- export type EventObject14 = {
244
- types?: Types15;
177
+ export type PullRequestReviewCommentEvent = {
245
178
  [k: string]: unknown;
246
- } & ({
247
- [k: string]: unknown;
248
- } | null);
249
- /**
250
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
251
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
252
- */
253
- export type Types15 = ([unknown, ...unknown[]] | string) & ('created' | 'edited' | 'deleted')[];
179
+ } | null;
254
180
  /**
255
181
  * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
256
182
  * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
257
183
  */
258
- export type Types16 = ([unknown, ...unknown[]] | string) & ('assigned' | 'unassigned' | 'labeled' | 'unlabeled' | 'opened' | 'edited' | 'closed' | 'reopened' | 'synchronize' | 'converted_to_draft' | 'ready_for_review' | 'locked' | 'unlocked' | 'review_requested' | 'review_request_removed' | 'auto_merge_enabled' | 'auto_merge_disabled')[];
184
+ export type PullRequestTargetEventTypes = ([unknown, ...unknown[]] | string) & ('assigned' | 'unassigned' | 'labeled' | 'unlabeled' | 'opened' | 'edited' | 'closed' | 'reopened' | 'synchronize' | 'converted_to_draft' | 'ready_for_review' | 'locked' | 'unlocked' | 'review_requested' | 'review_request_removed' | 'auto_merge_enabled' | 'auto_merge_disabled')[];
259
185
  /**
260
186
  * Runs your workflow anytime a package is published or updated. For more information, see https://help.github.com/en/github/managing-packages-with-github-packages.
261
187
  */
262
- export type EventObject15 = {
263
- types?: Types17;
264
- [k: string]: unknown;
265
- } & ({
188
+ export type RegistryPackageEvent = {
266
189
  [k: string]: unknown;
267
- } | null);
268
- /**
269
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
270
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
271
- */
272
- export type Types17 = ([unknown, ...unknown[]] | string) & ('published' | 'updated')[];
190
+ } | null;
273
191
  /**
274
192
  * Runs your workflow anytime the release event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/releases/ in the GitHub Developer documentation.
275
193
  */
276
- export type EventObject16 = {
277
- types?: Types18;
194
+ export type ReleaseEvent = {
278
195
  [k: string]: unknown;
279
- } & ({
196
+ } | null;
197
+ /**
198
+ * Runs your workflow anytime the status of a Git commit changes, which triggers the status event. For information about the REST API, see https://developer.github.com/v3/repos/statuses/.
199
+ */
200
+ export type StatusEvent = {
280
201
  [k: string]: unknown;
281
- } | null);
202
+ } | null;
282
203
  /**
283
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
284
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
204
+ * Runs your workflow anytime the watch event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/activity/starring/.
285
205
  */
286
- export type Types18 = ([unknown, ...unknown[]] | string) & ('published' | 'unpublished' | 'created' | 'edited' | 'deleted' | 'prereleased' | 'released')[];
206
+ export type WatchEvent = {
207
+ [k: string]: unknown;
208
+ } | null;
287
209
  /**
288
210
  * A string identifier to associate with the input. The value of <input_id> is a map of the input's metadata. The <input_id> must be a unique identifier within the inputs object. The <input_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.
289
211
  *
@@ -318,28 +240,22 @@ export type WorkflowDispatchInput = {
318
240
  /**
319
241
  * The options of the dropdown list, if the type is a choice.
320
242
  *
321
- * @minItems 1
322
243
  */
323
244
  options?: [string, ...string[]];
324
245
  };
325
246
  /**
326
247
  * This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. For example, if your pull_request workflow generates build artifacts, you can create a new workflow that uses workflow_run to analyze the results and add a comment to the original pull request.
327
248
  */
328
- export type EventObject17 = {
329
- types?: Types19;
330
- /**
331
- * @minItems 1
332
- */
333
- workflows?: [string, ...string[]];
334
- [k: string]: unknown;
335
- } & ({
249
+ export type WorkflowRunEvent = {
336
250
  [k: string]: unknown;
337
- } | null);
251
+ } | null;
338
252
  /**
339
- * Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
340
- * You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.
253
+ * You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. For more information, see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event.
254
+ * To trigger the custom repository_dispatch webhook event, you must send a POST request to a GitHub API endpoint and provide an event_type name to describe the activity type. To trigger a workflow run, you must also configure your workflow to use the repository_dispatch event.
341
255
  */
342
- export type Types19 = ([unknown, ...unknown[]] | string) & ('requested' | 'completed' | 'in_progress')[];
256
+ export type RepositoryDispatchEvent = {
257
+ [k: string]: unknown;
258
+ } | null;
343
259
  export type StringContainingExpressionSyntax = string;
344
260
  /**
345
261
  * You can override the default shell settings in the runner's operating system using the shell keyword. You can use built-in shell keywords, or you can define a custom set of shell options.
@@ -506,67 +422,27 @@ export interface Workflow {
506
422
  * The name of the GitHub event that triggers the workflow. You can provide a single event string, array of events, array of event types, or an event configuration map that schedules a workflow or restricts the execution of a workflow to specific files, tags, or branch changes. For a list of available events, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows.
507
423
  */
508
424
  on: Event | [Event, ...Event[]] | {
509
- branch_protection_rule?: EventObject;
510
- check_run?: EventObject1;
511
- check_suite?: EventObject2;
512
- /**
513
- * Runs your workflow anytime someone creates a branch or tag, which triggers the create event. For information about the REST API, see https://developer.github.com/v3/git/refs/#create-a-reference.
514
- */
515
- create?: {
516
- [k: string]: unknown;
517
- } | null;
518
- /**
519
- * Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. For information about the REST API, see https://developer.github.com/v3/git/refs/#delete-a-reference.
520
- */
521
- delete?: {
522
- [k: string]: unknown;
523
- } | null;
524
- /**
525
- * Runs your workflow anytime someone creates a deployment, which triggers the deployment event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/.
526
- */
527
- deployment?: {
528
- [k: string]: unknown;
529
- } | null;
530
- /**
531
- * Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status.
532
- */
533
- deployment_status?: {
534
- [k: string]: unknown;
535
- } | null;
536
- discussion?: EventObject3;
537
- discussion_comment?: EventObject4;
538
- /**
539
- * Runs your workflow anytime when someone forks a repository, which triggers the fork event. For information about the REST API, see https://developer.github.com/v3/repos/forks/#create-a-fork.
540
- */
541
- fork?: {
542
- [k: string]: unknown;
543
- } | null;
544
- /**
545
- * Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.
546
- */
547
- gollum?: {
548
- [k: string]: unknown;
549
- } | null;
550
- issue_comment?: EventObject5;
551
- issues?: EventObject6;
552
- label?: EventObject7;
553
- merge_group?: EventObject8;
554
- milestone?: EventObject9;
555
- /**
556
- * Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. For information about the REST API, see https://developer.github.com/v3/repos/pages/.
557
- */
558
- page_build?: {
559
- [k: string]: unknown;
560
- } | null;
561
- project?: EventObject10;
562
- project_card?: EventObject11;
563
- project_column?: EventObject12;
564
- /**
565
- * Runs your workflow anytime someone makes a private repository public, which triggers the public event. For information about the REST API, see https://developer.github.com/v3/repos/#edit.
566
- */
567
- public?: {
568
- [k: string]: unknown;
569
- } | null;
425
+ branch_protection_rule?: BranchProtectionRuleEvent;
426
+ check_run?: CheckRunEvent;
427
+ check_suite?: CheckSuiteEvent;
428
+ create?: CreateEvent;
429
+ delete?: DeleteEvent;
430
+ deployment?: DeploymentEvent;
431
+ deployment_status?: DeploymentStatusEvent;
432
+ discussion?: DiscussionEvent;
433
+ discussion_comment?: DiscussionCommentEvent;
434
+ fork?: ForkEvent;
435
+ gollum?: GollumEvent;
436
+ issue_comment?: IssueCommentEvent;
437
+ issues?: IssuesEvent;
438
+ label?: LabelEvent;
439
+ merge_group?: MergeGroupEvent;
440
+ milestone?: MilestoneEvent;
441
+ page_build?: PageBuildEvent;
442
+ project?: ProjectEvent;
443
+ project_card?: ProjectCardEvent;
444
+ project_column?: ProjectColumnEvent;
445
+ public?: PublicEvent;
570
446
  /**
571
447
  * Runs your workflow anytime the pull_request event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls.
572
448
  * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository.
@@ -575,7 +451,7 @@ export interface Workflow {
575
451
  * The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.
576
452
  */
577
453
  pull_request?: null | ({
578
- types?: Types13;
454
+ types?: PullRequestEventTypes;
579
455
  branches?: Branch;
580
456
  'branches-ignore'?: Branch;
581
457
  tags?: Branch;
@@ -585,13 +461,13 @@ export interface Workflow {
585
461
  } & {
586
462
  [k: string]: unknown;
587
463
  });
588
- pull_request_review?: EventObject13;
589
- pull_request_review_comment?: EventObject14;
464
+ pull_request_review?: PullRequestReviewEvent;
465
+ pull_request_review_comment?: PullRequestReviewCommentEvent;
590
466
  /**
591
467
  * This event is similar to pull_request, except that it runs in the context of the base repository of the pull request, rather than in the merge commit. This means that you can more safely make your secrets available to the workflows triggered by the pull request, because only workflows defined in the commit on the base repository are run. For example, this event allows you to create workflows that label and comment on pull requests, based on the contents of the event payload.
592
468
  */
593
469
  pull_request_target?: null | ({
594
- types?: Types16;
470
+ types?: PullRequestTargetEventTypes;
595
471
  branches?: Branch;
596
472
  'branches-ignore'?: Branch;
597
473
  tags?: Branch;
@@ -615,20 +491,10 @@ export interface Workflow {
615
491
  } & {
616
492
  [k: string]: unknown;
617
493
  });
618
- registry_package?: EventObject15;
619
- release?: EventObject16;
620
- /**
621
- * Runs your workflow anytime the status of a Git commit changes, which triggers the status event. For information about the REST API, see https://developer.github.com/v3/repos/statuses/.
622
- */
623
- status?: {
624
- [k: string]: unknown;
625
- } | null;
626
- /**
627
- * Runs your workflow anytime the watch event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/activity/starring/.
628
- */
629
- watch?: {
630
- [k: string]: unknown;
631
- } | null;
494
+ registry_package?: RegistryPackageEvent;
495
+ release?: ReleaseEvent;
496
+ status?: StatusEvent;
497
+ watch?: WatchEvent;
632
498
  /**
633
499
  * Allows workflows to be reused by other workflows.
634
500
  */
@@ -717,20 +583,13 @@ export interface Workflow {
717
583
  [k: string]: WorkflowDispatchInput;
718
584
  };
719
585
  };
720
- workflow_run?: EventObject17;
721
- /**
722
- * You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. For more information, see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event.
723
- * To trigger the custom repository_dispatch webhook event, you must send a POST request to a GitHub API endpoint and provide an event_type name to describe the activity type. To trigger a workflow run, you must also configure your workflow to use the repository_dispatch event.
724
- */
725
- repository_dispatch?: {
726
- [k: string]: unknown;
727
- } | null;
586
+ workflow_run?: WorkflowRunEvent;
587
+ repository_dispatch?: RepositoryDispatchEvent;
728
588
  /**
729
589
  * You can schedule a workflow to run at specific UTC times using POSIX cron syntax (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07). Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes.
730
590
  * Note: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.
731
591
  * You can use crontab guru (https://crontab.guru/). to help generate your cron syntax and confirm what time it will run. To help you get started, there is also a list of crontab guru examples (https://crontab.guru/examples.html).
732
592
  *
733
- * @minItems 1
734
593
  */
735
594
  schedule?: [
736
595
  {
@@ -837,7 +696,6 @@ export interface NormalJob {
837
696
  * Must contain either `uses` or `run`
838
697
  *
839
698
  *
840
- * @minItems 1
841
699
  */
842
700
  steps?: [Step, ...Step[]];
843
701
  /**
@@ -885,6 +743,7 @@ export interface NormalJob {
885
743
  }
886
744
  export interface PermissionsEvent {
887
745
  actions?: PermissionsLevel;
746
+ 'artifact-metadata'?: PermissionsLevel;
888
747
  attestations?: PermissionsLevel;
889
748
  checks?: PermissionsLevel;
890
749
  contents?: PermissionsLevel;
@@ -944,7 +803,6 @@ export interface Container {
944
803
  /**
945
804
  * Sets an array of ports to expose on the container.
946
805
  *
947
- * @minItems 1
948
806
  */
949
807
  ports?: [number | string, ...(number | string)[]];
950
808
  /**
@@ -952,7 +810,6 @@ export interface Container {
952
810
  * To specify a volume, you specify the source and destination path: <source>:<destinationPath>
953
811
  * The <source> is a volume name or an absolute path on the host machine, and <destinationPath> is an absolute path in the container.
954
812
  *
955
- * @minItems 1
956
813
  */
957
814
  volumes?: [string, ...string[]];
958
815
  /**