From 204cfff36f251549b6101484013006e38b3d20bf Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 17 Jun 2026 03:29:48 +0000 Subject: [PATCH 1/3] chore: update types --- .../lib/src/types/githubActionsWorkflow.ts | 431 +++++++----------- 1 file changed, 171 insertions(+), 260 deletions(-) diff --git a/packages/lib/src/types/githubActionsWorkflow.ts b/packages/lib/src/types/githubActionsWorkflow.ts index 0c0be77..a2e72a3 100755 --- a/packages/lib/src/types/githubActionsWorkflow.ts +++ b/packages/lib/src/types/githubActionsWorkflow.ts @@ -42,160 +42,14 @@ export type Event = | 'workflow_dispatch' | 'workflow_run' | 'repository_dispatch' -/** - * Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event. - */ -export type BranchProtectionRuleEvent = { - [k: string]: unknown -} | null -/** - * 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. - */ -export type CheckRunEvent = { - [k: string]: unknown -} | null -/** - * 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/. - */ -export type CheckSuiteEvent = { - [k: string]: unknown -} | null -/** - * 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. - */ -export type CreateEvent = { - [k: string]: unknown -} | null -/** - * 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. - */ -export type DeleteEvent = { - [k: string]: unknown -} | null -/** - * 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/. - */ -export type DeploymentEvent = { - [k: string]: unknown -} | null -/** - * 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. - */ -export type DeploymentStatusEvent = { - [k: string]: unknown -} | null -/** - * 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 - */ -export type DiscussionEvent = { - [k: string]: unknown -} | null -/** - * 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 - */ -export type DiscussionCommentEvent = { - [k: string]: unknown -} | null -/** - * 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. - */ -export type ForkEvent = { - [k: string]: unknown -} | null -/** - * Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. - */ -export type GollumEvent = { - [k: string]: unknown -} | null -/** - * 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/. - */ -export type IssueCommentEvent = { - [k: string]: unknown -} | null -/** - * 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. - */ -export type IssuesEvent = { - [k: string]: unknown -} | null -/** - * 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/. - */ -export type LabelEvent = { - [k: string]: unknown -} | null -/** - * 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 . - */ -export type MergeGroupEvent = { - [k: string]: unknown -} | null -/** - * 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/. - */ -export type MilestoneEvent = { - [k: string]: unknown -} | null -/** - * 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/. - */ -export type PageBuildEvent = { - [k: string]: unknown -} | null -/** - * 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/. - */ -export type ProjectEvent = { - [k: string]: unknown -} | null -/** - * 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. - */ -export type ProjectCardEvent = { - [k: string]: unknown -} | null -/** - * 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. - */ -export type ProjectColumnEvent = { - [k: string]: unknown -} | null -/** - * 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. - */ -export type PublicEvent = { +export type EventObject = { [k: string]: unknown } | null /** * 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. * 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. */ -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' - )[] +export type Types = [unknown, ...unknown[]] | string /** * 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. * 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. @@ -218,74 +72,6 @@ export type Branch = [string, ...string[]] * */ export type Path = [string, ...string[]] -/** - * Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews. - * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. - * When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. - * Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. - * 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. - */ -export type PullRequestReviewEvent = { - [k: string]: unknown -} | null -/** - * 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. - * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. - * When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. - * Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. - * 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. - */ -export type PullRequestReviewCommentEvent = { - [k: string]: unknown -} | null -/** - * 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. - * 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. - */ -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' - )[] -/** - * 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. - */ -export type RegistryPackageEvent = { - [k: string]: unknown -} | null -/** - * 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. - */ -export type ReleaseEvent = { - [k: string]: unknown -} | null -/** - * 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/. - */ -export type StatusEvent = { - [k: string]: unknown -} | null -/** - * 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/. - */ -export type WatchEvent = { - [k: string]: unknown -} | null /** * A string identifier to associate with the input. The value of is a map of the input's metadata. The must be a unique identifier within the inputs object. The must start with a letter or _ and contain only alphanumeric characters, -, or _. * @@ -323,19 +109,6 @@ export type WorkflowDispatchInput = { */ options?: [string, ...string[]] } -/** - * 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. - */ -export type WorkflowRunEvent = { - [k: string]: unknown -} | null -/** - * 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. - * 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. - */ -export type RepositoryDispatchEvent = { - [k: string]: unknown -} | null export type StringContainingExpressionSyntax = string /** * 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. @@ -528,27 +301,90 @@ export interface Workflow { | Event | [Event, ...Event[]] | { - branch_protection_rule?: BranchProtectionRuleEvent - check_run?: CheckRunEvent - check_suite?: CheckSuiteEvent - create?: CreateEvent - delete?: DeleteEvent - deployment?: DeploymentEvent - deployment_status?: DeploymentStatusEvent - discussion?: DiscussionEvent - discussion_comment?: DiscussionCommentEvent - fork?: ForkEvent - gollum?: GollumEvent - issue_comment?: IssueCommentEvent - issues?: IssuesEvent - label?: LabelEvent - merge_group?: MergeGroupEvent - milestone?: MilestoneEvent - page_build?: PageBuildEvent - project?: ProjectEvent - project_card?: ProjectCardEvent - project_column?: ProjectColumnEvent - public?: PublicEvent + /** + * Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event. + */ + branch_protection_rule?: EventObject + /** + * 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. + */ + check_run?: EventObject + /** + * 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/. + */ + check_suite?: EventObject + /** + * 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. + */ + create?: EventObject + /** + * 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. + */ + delete?: EventObject + /** + * 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/. + */ + deployment?: EventObject + /** + * 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. + */ + deployment_status?: EventObject + /** + * 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 + */ + discussion?: EventObject + /** + * 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 + */ + discussion_comment?: EventObject + /** + * 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. + */ + fork?: EventObject + /** + * Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. + */ + gollum?: EventObject + /** + * 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/. + */ + issue_comment?: EventObject + /** + * 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. + */ + issues?: EventObject + /** + * 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/. + */ + label?: EventObject + /** + * 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 . + */ + merge_group?: EventObject + /** + * 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/. + */ + milestone?: EventObject + /** + * 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/. + */ + page_build?: EventObject + /** + * 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/. + */ + project?: EventObject + /** + * 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. + */ + project_card?: EventObject + /** + * 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. + */ + project_column?: EventObject + /** + * 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. + */ + public?: EventObject /** * 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. * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. @@ -559,7 +395,30 @@ export interface Workflow { pull_request?: | null | ({ - types?: PullRequestEventTypes + types?: Types & + ( + | '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' + )[] branches?: Branch 'branches-ignore'?: Branch tags?: Branch @@ -569,15 +428,48 @@ export interface Workflow { } & { [k: string]: unknown }) - pull_request_review?: PullRequestReviewEvent - pull_request_review_comment?: PullRequestReviewCommentEvent + /** + * Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews. + * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. + * When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. + * Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. + * 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. + */ + pull_request_review?: EventObject + /** + * 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. + * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. + * When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. + * Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. + * 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. + */ + pull_request_review_comment?: EventObject /** * 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. */ pull_request_target?: | null | ({ - types?: PullRequestTargetEventTypes + types?: Types & + ( + | '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' + )[] branches?: Branch 'branches-ignore'?: Branch tags?: Branch @@ -603,10 +495,22 @@ export interface Workflow { } & { [k: string]: unknown }) - registry_package?: RegistryPackageEvent - release?: ReleaseEvent - status?: StatusEvent - watch?: WatchEvent + /** + * 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. + */ + registry_package?: EventObject + /** + * 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. + */ + release?: EventObject + /** + * 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/. + */ + status?: EventObject + /** + * 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/. + */ + watch?: EventObject /** * Allows workflows to be reused by other workflows. */ @@ -695,8 +599,15 @@ export interface Workflow { [k: string]: WorkflowDispatchInput } } - workflow_run?: WorkflowRunEvent - repository_dispatch?: RepositoryDispatchEvent + /** + * 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. + */ + workflow_run?: EventObject + /** + * 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. + * 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. + */ + repository_dispatch?: EventObject /** * 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). You can optionally specify a timezone using an IANA timezone string (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for timezone-aware scheduling. 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. * Note: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot. From 3f5898c10be5752af5123c780691d1e0c9a63587 Mon Sep 17 00:00:00 2001 From: Emmanuel N Kyeyune Date: Tue, 11 Aug 2026 12:48:04 -0400 Subject: [PATCH 2/3] fix(types): handle allOf-wrapped schema refs to restore named event types Upstream schema now wraps eventObject/types refs in single-element allOf, which json-schema-to-typescript compiles to a shared EventObject alias and drops sibling properties. Unwrap the refs during preprocessing and inline eventObject for events carrying their own activity-types enum, restoring the named *Event aliases and surfacing the new per-event *EventTypes. Also picks up the new background step keywords (background, wait, wait-all, cancel, parallel) added to the schema. --- packages/lib/scripts/generateWorkflowTypes.ts | 89 +- .../lib/src/types/githubActionsWorkflow.ts | 800 ++++++++++++++---- 2 files changed, 705 insertions(+), 184 deletions(-) diff --git a/packages/lib/scripts/generateWorkflowTypes.ts b/packages/lib/scripts/generateWorkflowTypes.ts index 9077145..7874c17 100755 --- a/packages/lib/scripts/generateWorkflowTypes.ts +++ b/packages/lib/scripts/generateWorkflowTypes.ts @@ -17,6 +17,54 @@ function toPascalCase(str: string): string { .join('') } +/** + * True if the node is a lone single-element allOf wrapper around the given $ref, + * i.e. { allOf: [{ $ref }] } (the schema moved refs into allOf wrappers). + */ +function hasSingleAllOfRef(node: JSONSchema, ref: string): boolean { + return ( + Array.isArray(node.allOf) && + node.allOf.length === 1 && + node.allOf[0]?.$ref === ref && + Object.keys(node.allOf[0]).length === 1 + ) +} + +/** + * json-schema-to-typescript drops sibling keywords next to allOf, so unwrap + * { allOf: [{ $ref }], ...siblings } back to { $ref, ...siblings } which it + * compiles as an intersection. + */ +function unwrapAllOfRef(node: JSONSchema, ref: string): void { + if (hasSingleAllOfRef(node, ref)) { + node.$ref = ref + delete node.allOf + } +} + +/** + * Names a `types` activity-types node (direct or allOf-wrapped ref to + * #/definitions/types) so it compiles as `EventTypes`. + */ +function addTitleToTypesNode( + typesNode: JSONSchema | undefined, + pascalEventName: string, +): void { + if ( + typeof typesNode !== 'object' || + typesNode === null || + Array.isArray(typesNode) + ) { + return + } + + unwrapAllOfRef(typesNode, '#/definitions/types') + + if (typesNode.$ref === '#/definitions/types') { + typesNode.title = `${pascalEventName}EventTypes` + } +} + /** * Pre-processes the JSON schema to add title properties to inline event schemas. * This gives json-schema-to-typescript meaningful names instead of EventObject1, Types2, etc. @@ -46,25 +94,44 @@ function addTitlesToEventSchemas(schema: JSONSchema): JSONSchema { const pascalEventName = toPascalCase(eventName) - // Add title to the event object schema if it references eventObject - if (eventSchema.$ref === '#/definitions/eventObject') { - eventSchema.title = `${pascalEventName}Event` + // Events referencing eventObject, either directly or via an allOf wrapper + if ( + eventSchema.$ref === '#/definitions/eventObject' || + hasSingleAllOfRef(eventSchema, '#/definitions/eventObject') + ) { + if (eventSchema.properties?.types) { + // The event carries its own activity-types enum alongside the + // eventObject ref. json-schema-to-typescript drops sibling properties + // next to allOf, so inline eventObject (object | null) as a oneOf + // carrying the event's own properties. + addTitleToTypesNode(eventSchema.properties.types, pascalEventName) + eventSchema.title = `${pascalEventName}Event` + eventSchema.oneOf = [ + { + type: 'object', + properties: eventSchema.properties, + additionalProperties: true, + }, + { type: 'null' }, + ] + delete eventSchema.allOf + delete eventSchema.$ref + delete eventSchema.properties + } else { + unwrapAllOfRef(eventSchema, '#/definitions/eventObject') + eventSchema.title = `${pascalEventName}Event` + } } - // Add title to the types property if it exists and references types - // Direct property access (most events) - if (eventSchema.properties?.types?.$ref === '#/definitions/types') { - eventSchema.properties.types.title = `${pascalEventName}EventTypes` - } + // Direct types property (events not referencing eventObject) + addTitleToTypesNode(eventSchema.properties?.types, pascalEventName) // Handle oneOf > allOf structure (pull_request, pull_request_target, push) if (Array.isArray(eventSchema.oneOf)) { for (const oneOfItem of eventSchema.oneOf) { if (Array.isArray(oneOfItem?.allOf)) { for (const allOfItem of oneOfItem.allOf) { - if (allOfItem?.properties?.types?.$ref === '#/definitions/types') { - allOfItem.properties.types.title = `${pascalEventName}EventTypes` - } + addTitleToTypesNode(allOfItem?.properties?.types, pascalEventName) } } } diff --git a/packages/lib/src/types/githubActionsWorkflow.ts b/packages/lib/src/types/githubActionsWorkflow.ts index a2e72a3..1045a55 100755 --- a/packages/lib/src/types/githubActionsWorkflow.ts +++ b/packages/lib/src/types/githubActionsWorkflow.ts @@ -42,14 +42,284 @@ export type Event = | 'workflow_dispatch' | 'workflow_run' | 'repository_dispatch' -export type EventObject = { +/** + * Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event. + */ +export type BranchProtectionRuleEvent = { + types?: BranchProtectionRuleEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type BranchProtectionRuleEventTypes = ( + [unknown, ...unknown[]] | string +) & + ('created' | 'edited' | 'deleted')[] +/** + * 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. + */ +export type CheckRunEvent = { + types?: CheckRunEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type CheckRunEventTypes = ([unknown, ...unknown[]] | string) & + ('created' | 'rerequested' | 'completed' | 'requested_action')[] +/** + * 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/. + */ +export type CheckSuiteEvent = { + types?: CheckSuiteEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type CheckSuiteEventTypes = ([unknown, ...unknown[]] | string) & + ('completed' | 'requested' | 'rerequested')[] +/** + * 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. + */ +export type CreateEvent = { + [k: string]: unknown +} | null +/** + * 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. + */ +export type DeleteEvent = { + [k: string]: unknown +} | null +/** + * 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/. + */ +export type DeploymentEvent = { + [k: string]: unknown +} | null +/** + * 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. + */ +export type DeploymentStatusEvent = { + [k: string]: unknown +} | null +/** + * 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 + */ +export type DiscussionEvent = { + types?: DiscussionEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type DiscussionEventTypes = ([unknown, ...unknown[]] | string) & + ( + | 'created' + | 'edited' + | 'deleted' + | 'transferred' + | 'pinned' + | 'unpinned' + | 'labeled' + | 'unlabeled' + | 'locked' + | 'unlocked' + | 'category_changed' + | 'answered' + | 'unanswered' + )[] +/** + * 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 + */ +export type DiscussionCommentEvent = { + types?: DiscussionCommentEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type DiscussionCommentEventTypes = ([unknown, ...unknown[]] | string) & + ('created' | 'edited' | 'deleted')[] +/** + * 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. + */ +export type ForkEvent = { + [k: string]: unknown +} | null +/** + * Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. + */ +export type GollumEvent = { + [k: string]: unknown +} | null +/** + * 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/. + */ +export type IssueCommentEvent = { + types?: IssueCommentEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type IssueCommentEventTypes = ([unknown, ...unknown[]] | string) & + ('created' | 'edited' | 'deleted')[] +/** + * 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. + */ +export type IssuesEvent = { + types?: IssuesEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type IssuesEventTypes = ([unknown, ...unknown[]] | string) & + ( + | 'opened' + | 'edited' + | 'deleted' + | 'transferred' + | 'pinned' + | 'unpinned' + | 'closed' + | 'reopened' + | 'assigned' + | 'unassigned' + | 'labeled' + | 'unlabeled' + | 'locked' + | 'unlocked' + | 'milestoned' + | 'demilestoned' + )[] +/** + * 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/. + */ +export type LabelEvent = { + types?: LabelEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type LabelEventTypes = ([unknown, ...unknown[]] | string) & + ('created' | 'edited' | 'deleted')[] +/** + * 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 . + */ +export type MergeGroupEvent = { + types?: MergeGroupEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type MergeGroupEventTypes = ([unknown, ...unknown[]] | string) & + 'checks_requested'[] +/** + * 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/. + */ +export type MilestoneEvent = { + types?: MilestoneEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type MilestoneEventTypes = ([unknown, ...unknown[]] | string) & + ('created' | 'closed' | 'opened' | 'edited' | 'deleted')[] +/** + * 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/. + */ +export type PageBuildEvent = { + [k: string]: unknown +} | null +/** + * 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/. + */ +export type ProjectEvent = { + types?: ProjectEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type ProjectEventTypes = ([unknown, ...unknown[]] | string) & + ('created' | 'updated' | 'closed' | 'reopened' | 'edited' | 'deleted')[] +/** + * 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. + */ +export type ProjectCardEvent = { + types?: ProjectCardEventTypes [k: string]: unknown } | null /** * 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. * 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. */ -export type Types = [unknown, ...unknown[]] | string +export type ProjectCardEventTypes = ([unknown, ...unknown[]] | string) & + ('created' | 'moved' | 'converted' | 'edited' | 'deleted')[] +/** + * 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. + */ +export type ProjectColumnEvent = { + types?: ProjectColumnEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type ProjectColumnEventTypes = ([unknown, ...unknown[]] | string) & + ('created' | 'updated' | 'moved' | 'deleted')[] +/** + * 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. + */ +export type PublicEvent = { + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +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' + )[] /** * 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. * 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. @@ -72,6 +342,112 @@ export type Branch = [string, ...string[]] * */ export type Path = [string, ...string[]] +/** + * Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews. + * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. + * When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. + * Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. + * 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. + */ +export type PullRequestReviewEvent = { + types?: PullRequestReviewEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type PullRequestReviewEventTypes = ([unknown, ...unknown[]] | string) & + ('submitted' | 'edited' | 'dismissed')[] +/** + * 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. + * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. + * When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. + * Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. + * 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. + */ +export type PullRequestReviewCommentEvent = { + types?: PullRequestReviewCommentEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type PullRequestReviewCommentEventTypes = ( + [unknown, ...unknown[]] | string +) & + ('created' | 'edited' | 'deleted')[] +/** + * 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. + * 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. + */ +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' + )[] +/** + * 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. + */ +export type RegistryPackageEvent = { + types?: RegistryPackageEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type RegistryPackageEventTypes = ([unknown, ...unknown[]] | string) & + ('published' | 'updated')[] +/** + * 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. + */ +export type ReleaseEvent = { + types?: ReleaseEventTypes + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type ReleaseEventTypes = ([unknown, ...unknown[]] | string) & + ( + | 'published' + | 'unpublished' + | 'created' + | 'edited' + | 'deleted' + | 'prereleased' + | 'released' + )[] +/** + * 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/. + */ +export type StatusEvent = { + [k: string]: unknown +} | null +/** + * 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/. + */ +export type WatchEvent = { + [k: string]: unknown +} | null /** * A string identifier to associate with the input. The value of is a map of the input's metadata. The must be a unique identifier within the inputs object. The must start with a letter or _ and contain only alphanumeric characters, -, or _. * @@ -109,13 +485,35 @@ export type WorkflowDispatchInput = { */ options?: [string, ...string[]] } +/** + * 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. + */ +export type WorkflowRunEvent = { + types?: WorkflowRunEventTypes + /** + */ + workflows?: [string, ...string[]] + [k: string]: unknown +} | null +/** + * 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. + * 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. + */ +export type WorkflowRunEventTypes = ([unknown, ...unknown[]] | string) & + ('requested' | 'completed' | 'in_progress')[] +/** + * 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. + * 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. + */ +export type RepositoryDispatchEvent = { + [k: string]: unknown +} | null export type StringContainingExpressionSyntax = string /** * 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. */ export type Shell = - | string - | ('bash' | 'pwsh' | 'python' | 'sh' | 'cmd' | 'powershell') + string | ('bash' | 'pwsh' | 'python' | 'sh' | 'cmd' | 'powershell') /** * Using the working-directory keyword, you can specify the working directory of where to run the command. */ @@ -192,6 +590,27 @@ export type Step = { * The maximum number of minutes to run the step before killing the process. */ 'timeout-minutes'?: number | ExpressionSyntax + /** + * Runs a step asynchronously so the job continues to the next step without waiting for it to finish. You can use background on steps that use run or uses. To reference a background step from wait or cancel, give it an id. A maximum of 10 background steps can run concurrently in a single job. + */ + background?: boolean + /** + * Pauses the job until one or more background steps complete. Provide a single step id as a string, or multiple step ids as an array. After a wait step completes, the outputs of the referenced background steps become available to subsequent steps. + */ + wait?: string | [string, ...string[]] + /** + * Pauses the job until all active background steps complete. The wait-all keyword takes no arguments. + */ + 'wait-all'?: boolean | null + /** + * Gracefully terminates a running background step. The runner sends the step's process a termination signal (SIGTERM) so it can clean up. The cancel keyword targets a single background step by its id. + */ + cancel?: string + /** + * Runs a group of steps concurrently, then waits for all of them to finish before continuing. Every step in the group runs as a background step, with an implicit wait at the end of the group. + * + */ + parallel?: [Step, ...Step[]] } & Step1 & { /** * A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. @@ -241,6 +660,167 @@ export type Step = { * The maximum number of minutes to run the step before killing the process. */ 'timeout-minutes'?: number | ExpressionSyntax + /** + * Runs a step asynchronously so the job continues to the next step without waiting for it to finish. You can use background on steps that use run or uses. To reference a background step from wait or cancel, give it an id. A maximum of 10 background steps can run concurrently in a single job. + */ + background?: boolean + /** + * Pauses the job until one or more background steps complete. Provide a single step id as a string, or multiple step ids as an array. After a wait step completes, the outputs of the referenced background steps become available to subsequent steps. + */ + wait?: string | [string, ...string[]] + /** + * Pauses the job until all active background steps complete. The wait-all keyword takes no arguments. + */ + 'wait-all'?: boolean | null + /** + * Gracefully terminates a running background step. The runner sends the step's process a termination signal (SIGTERM) so it can clean up. The cancel keyword targets a single background step by its id. + */ + cancel?: string + /** + * Runs a group of steps concurrently, then waits for all of them to finish before continuing. Every step in the group runs as a background step, with an implicit wait at the end of the group. + * + */ + parallel?: [Step, ...Step[]] + } & Step1 & { + /** + * A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. + */ + id?: string + /** + * You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional. + * Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. + */ + if?: boolean | number | string + /** + * A name for your step to display on GitHub. + */ + name?: string + /** + * Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/). + * We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. + * - Using the commit SHA of a released action version is the safest for stability and security. + * - Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. + * - Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break. + * Some actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required. + * Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions. + */ + uses?: string + /** + * Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command. + * Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell. + * Each run keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell. + */ + run?: string + 'working-directory'?: WorkingDirectory + shell?: Shell + with?: Env + /** + * Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job. + */ + env?: + | { + [k: string]: string | number | boolean + } + | StringContainingExpressionSyntax + /** + * Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails. + */ + 'continue-on-error'?: boolean | ExpressionSyntax + /** + * The maximum number of minutes to run the step before killing the process. + */ + 'timeout-minutes'?: number | ExpressionSyntax + /** + * Runs a step asynchronously so the job continues to the next step without waiting for it to finish. You can use background on steps that use run or uses. To reference a background step from wait or cancel, give it an id. A maximum of 10 background steps can run concurrently in a single job. + */ + background?: boolean + /** + * Pauses the job until one or more background steps complete. Provide a single step id as a string, or multiple step ids as an array. After a wait step completes, the outputs of the referenced background steps become available to subsequent steps. + */ + wait?: string | [string, ...string[]] + /** + * Pauses the job until all active background steps complete. The wait-all keyword takes no arguments. + */ + 'wait-all'?: boolean | null + /** + * Gracefully terminates a running background step. The runner sends the step's process a termination signal (SIGTERM) so it can clean up. The cancel keyword targets a single background step by its id. + */ + cancel?: string + /** + * Runs a group of steps concurrently, then waits for all of them to finish before continuing. Every step in the group runs as a background step, with an implicit wait at the end of the group. + * + */ + parallel?: [Step, ...Step[]] + } & Step1 & { + /** + * A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. + */ + id?: string + /** + * You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional. + * Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. + */ + if?: boolean | number | string + /** + * A name for your step to display on GitHub. + */ + name?: string + /** + * Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/). + * We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. + * - Using the commit SHA of a released action version is the safest for stability and security. + * - Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. + * - Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break. + * Some actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required. + * Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions. + */ + uses?: string + /** + * Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command. + * Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell. + * Each run keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell. + */ + run?: string + 'working-directory'?: WorkingDirectory + shell?: Shell + with?: Env + /** + * Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job. + */ + env?: + | { + [k: string]: string | number | boolean + } + | StringContainingExpressionSyntax + /** + * Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails. + */ + 'continue-on-error'?: boolean | ExpressionSyntax + /** + * The maximum number of minutes to run the step before killing the process. + */ + 'timeout-minutes'?: number | ExpressionSyntax + /** + * Runs a step asynchronously so the job continues to the next step without waiting for it to finish. You can use background on steps that use run or uses. To reference a background step from wait or cancel, give it an id. A maximum of 10 background steps can run concurrently in a single job. + */ + background?: boolean + /** + * Pauses the job until one or more background steps complete. Provide a single step id as a string, or multiple step ids as an array. After a wait step completes, the outputs of the referenced background steps become available to subsequent steps. + */ + wait?: string | [string, ...string[]] + /** + * Pauses the job until all active background steps complete. The wait-all keyword takes no arguments. + */ + 'wait-all'?: boolean | null + /** + * Gracefully terminates a running background step. The runner sends the step's process a termination signal (SIGTERM) so it can clean up. The cancel keyword targets a single background step by its id. + */ + cancel?: string + /** + * Runs a group of steps concurrently, then waits for all of them to finish before continuing. Every step in the group runs as a background step, with an implicit wait at the end of the group. + * + */ + parallel?: [Step, ...Step[]] } & Step1 /** * A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case. @@ -262,6 +842,18 @@ export type Step1 = | { [k: string]: unknown } + | { + [k: string]: unknown + } + | { + [k: string]: unknown + } + | { + [k: string]: unknown + } + | { + [k: string]: unknown + } /** * A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status. * You can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix. @@ -301,90 +893,27 @@ export interface Workflow { | Event | [Event, ...Event[]] | { - /** - * Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event. - */ - branch_protection_rule?: EventObject - /** - * 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. - */ - check_run?: EventObject - /** - * 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/. - */ - check_suite?: EventObject - /** - * 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. - */ - create?: EventObject - /** - * 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. - */ - delete?: EventObject - /** - * 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/. - */ - deployment?: EventObject - /** - * 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. - */ - deployment_status?: EventObject - /** - * 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 - */ - discussion?: EventObject - /** - * 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 - */ - discussion_comment?: EventObject - /** - * 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. - */ - fork?: EventObject - /** - * Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. - */ - gollum?: EventObject - /** - * 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/. - */ - issue_comment?: EventObject - /** - * 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. - */ - issues?: EventObject - /** - * 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/. - */ - label?: EventObject - /** - * 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 . - */ - merge_group?: EventObject - /** - * 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/. - */ - milestone?: EventObject - /** - * 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/. - */ - page_build?: EventObject - /** - * 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/. - */ - project?: EventObject - /** - * 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. - */ - project_card?: EventObject - /** - * 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. - */ - project_column?: EventObject - /** - * 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. - */ - public?: EventObject + branch_protection_rule?: BranchProtectionRuleEvent + check_run?: CheckRunEvent + check_suite?: CheckSuiteEvent + create?: CreateEvent + delete?: DeleteEvent + deployment?: DeploymentEvent + deployment_status?: DeploymentStatusEvent + discussion?: DiscussionEvent + discussion_comment?: DiscussionCommentEvent + fork?: ForkEvent + gollum?: GollumEvent + issue_comment?: IssueCommentEvent + issues?: IssuesEvent + label?: LabelEvent + merge_group?: MergeGroupEvent + milestone?: MilestoneEvent + page_build?: PageBuildEvent + project?: ProjectEvent + project_card?: ProjectCardEvent + project_column?: ProjectColumnEvent + public?: PublicEvent /** * 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. * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. @@ -395,30 +924,7 @@ export interface Workflow { pull_request?: | null | ({ - types?: Types & - ( - | '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' - )[] + types?: PullRequestEventTypes branches?: Branch 'branches-ignore'?: Branch tags?: Branch @@ -428,48 +934,15 @@ export interface Workflow { } & { [k: string]: unknown }) - /** - * Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews. - * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. - * When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. - * Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. - * 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. - */ - pull_request_review?: EventObject - /** - * 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. - * Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. - * When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. - * Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. - * 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. - */ - pull_request_review_comment?: EventObject + pull_request_review?: PullRequestReviewEvent + pull_request_review_comment?: PullRequestReviewCommentEvent /** * 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. */ pull_request_target?: | null | ({ - types?: Types & - ( - | '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' - )[] + types?: PullRequestTargetEventTypes branches?: Branch 'branches-ignore'?: Branch tags?: Branch @@ -495,22 +968,10 @@ export interface Workflow { } & { [k: string]: unknown }) - /** - * 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. - */ - registry_package?: EventObject - /** - * 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. - */ - release?: EventObject - /** - * 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/. - */ - status?: EventObject - /** - * 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/. - */ - watch?: EventObject + registry_package?: RegistryPackageEvent + release?: ReleaseEvent + status?: StatusEvent + watch?: WatchEvent /** * Allows workflows to be reused by other workflows. */ @@ -599,15 +1060,8 @@ export interface Workflow { [k: string]: WorkflowDispatchInput } } - /** - * 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. - */ - workflow_run?: EventObject - /** - * 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. - * 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. - */ - repository_dispatch?: EventObject + workflow_run?: WorkflowRunEvent + repository_dispatch?: RepositoryDispatchEvent /** * 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). You can optionally specify a timezone using an IANA timezone string (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for timezone-aware scheduling. 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. * Note: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot. From dae6ba994b1de98d71184ab9e4086983970f9157 Mon Sep 17 00:00:00 2001 From: Emmanuel N Kyeyune Date: Tue, 11 Aug 2026 12:49:01 -0400 Subject: [PATCH 3/3] docs: regenerate API reference for updated workflow types --- .../Context/functions/getGlobalWacContext.md | 2 +- .../namespaces/Context/interfaces/Context.md | 8 +- .../functions/generateStackTrace.md | 2 +- .../functions/getEffectiveSeverity.md | 4 +- .../Diagnostics/functions/getSuppressions.md | 4 +- .../Diagnostics/functions/isCodeSuppressed.md | 4 +- .../functions/isSuppressedValue.md | 8 +- .../functions/matchesActionPattern.md | 2 +- .../Diagnostics/functions/suppress.md | 6 +- .../Diagnostics/functions/unwrapValue.md | 4 +- .../Diagnostics/interfaces/Diagnostic.md | 65 +++- .../interfaces/DiagnosticsReporter.md | 4 +- .../Diagnostics/interfaces/SuppressedValue.md | 10 +- .../type-aliases/ConfiguredSeverity.md | 2 +- .../type-aliases/DiagnosticRuleConfig.md | 2 +- .../type-aliases/DiagnosticRules.md | 2 +- .../type-aliases/DiagnosticSeverity.md | 2 +- .../variables/DiagnosticSeverity.md | 2 +- .../type-aliases/MatrixConfiguration.md | 2 +- .../GeneratedWorkflowTypes/README.md | 31 +- .../interfaces/Concurrency.md | 20 +- .../interfaces/Container.md | 83 ----- .../interfaces/Defaults.md | 10 +- .../interfaces/Defaults1.md | 10 +- .../interfaces/Environment.md | 18 +- .../interfaces/JobContainer.md | 83 +++++ .../interfaces/NormalJob.md | 76 ++--- .../interfaces/PermissionsEvent.md | 78 +++-- .../interfaces/ReusableWorkflowCallJob.md | 42 +-- .../interfaces/ServiceContainer.md | 103 ++++++ .../interfaces/Workflow.md | 206 ++++++------ .../type-aliases/Branch.md | 2 +- .../type-aliases/BranchProtectionRuleEvent.md | 4 +- .../BranchProtectionRuleEventTypes.md | 14 + .../type-aliases/CheckRunEvent.md | 4 +- .../type-aliases/CheckRunEventTypes.md | 14 + .../type-aliases/CheckSuiteEvent.md | 4 +- .../type-aliases/CheckSuiteEventTypes.md | 14 + .../type-aliases/Configuration.md | 2 +- .../type-aliases/CreateEvent.md | 2 +- .../type-aliases/DeleteEvent.md | 2 +- .../type-aliases/DeploymentEvent.md | 2 +- .../type-aliases/DeploymentStatusEvent.md | 2 +- .../type-aliases/DiscussionCommentEvent.md | 4 +- .../DiscussionCommentEventTypes.md | 14 + .../type-aliases/DiscussionEvent.md | 4 +- .../type-aliases/DiscussionEventTypes.md | 14 + .../type-aliases/Env.md | 6 +- .../type-aliases/Env1.md | 2 +- .../type-aliases/Event.md | 2 +- .../type-aliases/ExpressionSyntax.md | 2 +- .../type-aliases/ForkEvent.md | 2 +- .../type-aliases/GollumEvent.md | 2 +- .../type-aliases/IssueCommentEvent.md | 4 +- .../type-aliases/IssueCommentEventTypes.md | 14 + .../type-aliases/IssuesEvent.md | 4 +- .../type-aliases/IssuesEventTypes.md | 14 + .../type-aliases/JobNeeds.md | 2 +- .../type-aliases/LabelEvent.md | 4 +- .../type-aliases/LabelEventTypes.md | 14 + .../type-aliases/Matrix.md | 2 +- .../type-aliases/MergeGroupEvent.md | 4 +- .../type-aliases/MergeGroupEventTypes.md | 14 + .../type-aliases/MilestoneEvent.md | 4 +- .../type-aliases/MilestoneEventTypes.md | 14 + .../type-aliases/Name.md | 2 +- .../type-aliases/PageBuildEvent.md | 2 +- .../type-aliases/Path.md | 2 +- .../type-aliases/Permissions.md | 2 +- .../type-aliases/PermissionsLevel.md | 2 +- .../type-aliases/ProjectCardEvent.md | 4 +- .../type-aliases/ProjectCardEventTypes.md | 14 + .../type-aliases/ProjectColumnEvent.md | 4 +- .../type-aliases/ProjectColumnEventTypes.md | 14 + .../type-aliases/ProjectEvent.md | 4 +- .../type-aliases/ProjectEventTypes.md | 14 + .../type-aliases/PublicEvent.md | 2 +- .../type-aliases/PullRequestEventTypes.md | 2 +- .../PullRequestReviewCommentEvent.md | 4 +- .../PullRequestReviewCommentEventTypes.md | 14 + .../type-aliases/PullRequestReviewEvent.md | 4 +- .../PullRequestReviewEventTypes.md | 14 + .../PullRequestTargetEventTypes.md | 2 +- .../type-aliases/RegistryPackageEvent.md | 4 +- .../type-aliases/RegistryPackageEventTypes.md | 14 + .../type-aliases/ReleaseEvent.md | 4 +- .../type-aliases/ReleaseEventTypes.md | 14 + .../type-aliases/RepositoryDispatchEvent.md | 2 +- .../type-aliases/Shell.md | 2 +- .../type-aliases/Snapshot.md | 4 +- .../type-aliases/StatusEvent.md | 2 +- .../type-aliases/Step.md | 310 ++++++++++++++++-- .../type-aliases/Step1.md | 4 +- .../StringContainingExpressionSyntax.md | 2 +- .../type-aliases/WatchEvent.md | 2 +- .../type-aliases/WorkflowDispatchInput.md | 14 +- .../type-aliases/WorkflowRunEvent.md | 4 +- .../type-aliases/WorkflowRunEventTypes.md | 14 + .../type-aliases/WorkingDirectory.md | 2 +- docs/docs/api-reference/README.md | 6 + docs/docs/api-reference/classes/NormalJob.md | 20 +- .../classes/ReusableWorkflowCallJob.md | 10 +- docs/docs/api-reference/classes/Step.md | 12 +- docs/docs/api-reference/classes/Workflow.md | 47 ++- .../api-reference/functions/dedentString.md | 2 +- .../functions/multilineString.md | 2 +- .../type-aliases/WorkflowOptions.md | 31 ++ .../api-reference/variables/echoKeyValue.md | 2 +- .../api-reference/variables/expressions.md | 12 +- .../api-reference/variables/workflowOps.md | 4 +- 110 files changed, 1270 insertions(+), 489 deletions(-) delete mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Container.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/JobContainer.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/ServiceContainer.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/BranchProtectionRuleEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckRunEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckSuiteEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionCommentEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssueCommentEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssuesEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/LabelEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MergeGroupEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MilestoneEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectCardEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectColumnEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewCommentEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RegistryPackageEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ReleaseEventTypes.md create mode 100644 docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowRunEventTypes.md create mode 100644 docs/docs/api-reference/type-aliases/WorkflowOptions.md diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Context/functions/getGlobalWacContext.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Context/functions/getGlobalWacContext.md index 92f42ac..872e2cc 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Context/functions/getGlobalWacContext.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Context/functions/getGlobalWacContext.md @@ -8,7 +8,7 @@ > **getGlobalWacContext**(): [`Context`](../interfaces/Context.md) \| `undefined` -Defined in: [types/context.ts:22](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/context.ts#L22) +Defined in: [types/context.ts:22](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/context.ts#L22) ## Returns diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Context/interfaces/Context.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Context/interfaces/Context.md index 94819dd..abcee63 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Context/interfaces/Context.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Context/interfaces/Context.md @@ -6,15 +6,15 @@ # Interface: Context -Defined in: [types/context.ts:3](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/context.ts#L3) +Defined in: [types/context.ts:3](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/context.ts#L3) ## Properties ### diagnosticRules? -> `optional` **diagnosticRules**: [`DiagnosticRules`](../../Diagnostics/type-aliases/DiagnosticRules.md) +> `optional` **diagnosticRules?**: [`DiagnosticRules`](../../Diagnostics/type-aliases/DiagnosticRules.md) -Defined in: [types/context.ts:6](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/context.ts#L6) +Defined in: [types/context.ts:6](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/context.ts#L6) Configured diagnostic rules from wac.config.json @@ -24,4 +24,4 @@ Configured diagnostic rules from wac.config.json > **diagnostics**: [`DiagnosticsReporter`](../../Diagnostics/interfaces/DiagnosticsReporter.md) -Defined in: [types/context.ts:4](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/context.ts#L4) +Defined in: [types/context.ts:4](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/context.ts#L4) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/generateStackTrace.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/generateStackTrace.md index 28b4a34..abe758c 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/generateStackTrace.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/generateStackTrace.md @@ -8,7 +8,7 @@ > **generateStackTrace**(`constructorOpt?`): `string` -Defined in: [types/diagnostics.ts:115](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L115) +Defined in: [types/diagnostics.ts:161](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L161) ## Parameters diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/getEffectiveSeverity.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/getEffectiveSeverity.md index b253b68..bc2ebc8 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/getEffectiveSeverity.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/getEffectiveSeverity.md @@ -8,7 +8,7 @@ > **getEffectiveSeverity**(`diagnostic`, `rules`): [`DiagnosticSeverity`](../type-aliases/DiagnosticSeverity.md) \| `"off"` -Defined in: [types/diagnostics.ts:73](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L73) +Defined in: [types/diagnostics.ts:119](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L119) Determines the effective severity for a diagnostic based on configured rules. Returns the severity to use, or 'off' if the diagnostic should be suppressed. @@ -21,7 +21,7 @@ Returns the severity to use, or 'off' if the diagnostic should be suppressed. ### rules -[`DiagnosticRules`](../type-aliases/DiagnosticRules.md) | `undefined` +[`DiagnosticRules`](../type-aliases/DiagnosticRules.md) \| `undefined` ## Returns diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/getSuppressions.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/getSuppressions.md index fcd8ae3..7af6211 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/getSuppressions.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/getSuppressions.md @@ -8,7 +8,7 @@ > **getSuppressions**<`T`>(`val`): `object`[] \| `undefined` -Defined in: [types/diagnostics.ts:205](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L205) +Defined in: [types/diagnostics.ts:253](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L253) Gets suppression metadata from a value, if present. Returns undefined if the value is not suppressed. @@ -23,7 +23,7 @@ Returns undefined if the value is not suppressed. ### val -`T` | [`SuppressedValue`](../interfaces/SuppressedValue.md)<`T`> +`T` \| [`SuppressedValue`](../interfaces/SuppressedValue.md)<`T`> ## Returns diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/isCodeSuppressed.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/isCodeSuppressed.md index db96599..08cd716 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/isCodeSuppressed.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/isCodeSuppressed.md @@ -8,7 +8,7 @@ > **isCodeSuppressed**<`T`>(`val`, `code`): `boolean` -Defined in: [types/diagnostics.ts:217](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L217) +Defined in: [types/diagnostics.ts:265](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L265) Checks if a diagnostic code is suppressed for a given value. @@ -22,7 +22,7 @@ Checks if a diagnostic code is suppressed for a given value. ### val -`T` | [`SuppressedValue`](../interfaces/SuppressedValue.md)<`T`> +`T` \| [`SuppressedValue`](../interfaces/SuppressedValue.md)<`T`> ### code diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/isSuppressedValue.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/isSuppressedValue.md index 47ba414..3c3cfc1 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/isSuppressedValue.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/isSuppressedValue.md @@ -6,9 +6,9 @@ # Function: isSuppressedValue() -> **isSuppressedValue**<`T`>(`val`): `val is SuppressedValue` +> **isSuppressedValue**<`T`>(`val`): `val is SuppressedValue<T>` -Defined in: [types/diagnostics.ts:180](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L180) +Defined in: [types/diagnostics.ts:228](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L228) Type guard to check if a value is a SuppressedValue. @@ -22,8 +22,8 @@ Type guard to check if a value is a SuppressedValue. ### val -`T` | [`SuppressedValue`](../interfaces/SuppressedValue.md)<`T`> +`T` \| [`SuppressedValue`](../interfaces/SuppressedValue.md)<`T`> ## Returns -`val is SuppressedValue` +`val is SuppressedValue<T>` diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/matchesActionPattern.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/matchesActionPattern.md index 6ad7004..464c5c6 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/matchesActionPattern.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/matchesActionPattern.md @@ -8,7 +8,7 @@ > **matchesActionPattern**(`action`, `pattern`): `boolean` -Defined in: [types/diagnostics.ts:61](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L61) +Defined in: [types/diagnostics.ts:107](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L107) Checks if an action string matches a pattern. Supports wildcard (*) at the end of patterns. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/suppress.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/suppress.md index 0bb3ebc..6541bd2 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/suppress.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/suppress.md @@ -8,7 +8,7 @@ > **suppress**<`T`>(`value`, `codes`, `reason?`): [`SuppressedValue`](../interfaces/SuppressedValue.md)<`T`> -Defined in: [types/diagnostics.ts:164](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L164) +Defined in: [types/diagnostics.ts:212](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L212) Wraps a value with diagnostic suppression metadata. Use this to suppress specific warnings for a value in-code. @@ -29,9 +29,9 @@ The value to wrap ### codes -Diagnostic code(s) to suppress (e.g., 'action-version-semver-violation') +`string` \| `string`[] -`string` | `string`[] +Diagnostic code(s) to suppress (e.g., 'action-version-semver-violation') ### reason? diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/unwrapValue.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/unwrapValue.md index ff73193..b193de1 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/unwrapValue.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/functions/unwrapValue.md @@ -8,7 +8,7 @@ > **unwrapValue**<`T`>(`val`): `T` -Defined in: [types/diagnostics.ts:194](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L194) +Defined in: [types/diagnostics.ts:242](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L242) Unwraps a potentially suppressed value, returning the underlying value. @@ -22,7 +22,7 @@ Unwraps a potentially suppressed value, returning the underlying value. ### val -`T` | [`SuppressedValue`](../interfaces/SuppressedValue.md)<`T`> +`T` \| [`SuppressedValue`](../interfaces/SuppressedValue.md)<`T`> ## Returns diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/Diagnostic.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/Diagnostic.md index a9d7fe1..b880c76 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/Diagnostic.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/Diagnostic.md @@ -6,25 +6,36 @@ # Interface: Diagnostic -Defined in: [types/diagnostics.ts:39](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L39) +Defined in: [types/diagnostics.ts:39](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L39) ## Properties ### action? -> `optional` **action**: `string` +> `optional` **action?**: `string` -Defined in: [types/diagnostics.ts:46](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L46) +Defined in: [types/diagnostics.ts:92](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L92) -Optional action identifier for pattern matching (e.g., "actions/checkout@v4") +Optional action identifier for pattern matching (e.g., "actions/checkout@v4"). + +End users may specify an exclude pattern for a diagnostic code. This is +checked against the diagnostics "action" property, and if it matches, the +diagnostic will be supressed. + +This value should be provided if the diagnostic event relates to a specific +action. Otherwise, it can be omitted. *** ### cause? -> `optional` **cause**: `Error` +> `optional` **cause?**: `Error` + +Defined in: [types/diagnostics.ts:81](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L81) -Defined in: [types/diagnostics.ts:44](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L44) +An optional cause for the diagnostic event. If provided, the default +diagnostics reporter implementation will log this below the diagnostic +message. *** @@ -32,7 +43,18 @@ Defined in: [types/diagnostics.ts:44](https://github.com/emmanuelnk/github-actio > **code**: `string` -Defined in: [types/diagnostics.ts:41](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L41) +Defined in: [types/diagnostics.ts:52](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L52) + +The unique code for the diagnostic rule. This should be a unique kebab-case +string. It will be displayed to the user alongside the diagnostic message, +and can be used by end users to override the severity of the diagnostic +event. + +#### Example + +```ts +"my-custom-diagnostic-code" +``` *** @@ -40,7 +62,9 @@ Defined in: [types/diagnostics.ts:41](https://github.com/emmanuelnk/github-actio > **message**: `string` -Defined in: [types/diagnostics.ts:42](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L42) +Defined in: [types/diagnostics.ts:56](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L56) + +A short message explaining the error. *** @@ -48,12 +72,31 @@ Defined in: [types/diagnostics.ts:42](https://github.com/emmanuelnk/github-actio > **severity**: [`DiagnosticSeverity`](../type-aliases/DiagnosticSeverity.md) -Defined in: [types/diagnostics.ts:40](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L40) +Defined in: [types/diagnostics.ts:43](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L43) + +The severity of the diagnostic event. *** ### stack? -> `optional` **stack**: `string` +> `optional` **stack?**: `string` + +Defined in: [types/diagnostics.ts:75](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L75) + +The stack trace for the diagnostic event. This can be produced using the +`Diagnostics.generateStackTrace` helper: + +```ts +import { Diagnostics } from '@github-actions-workflow-ts/lib' + +export class MyCustomAction { + constructor(...) { + Diagnostics.generateStackTrace(this.constructor) + } +} +``` -Defined in: [types/diagnostics.ts:43](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L43) +Note that `Diagnostics.generateStackTrace` accepts an optional function +argument. If provided, the top frame of the stack trace will be the call +site of that function. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/DiagnosticsReporter.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/DiagnosticsReporter.md index ab26fd8..9de2b56 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/DiagnosticsReporter.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/DiagnosticsReporter.md @@ -6,7 +6,7 @@ # Interface: DiagnosticsReporter -Defined in: [types/diagnostics.ts:49](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L49) +Defined in: [types/diagnostics.ts:95](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L95) ## Methods @@ -14,7 +14,7 @@ Defined in: [types/diagnostics.ts:49](https://github.com/emmanuelnk/github-actio > **emit**(`d`): `void` -Defined in: [types/diagnostics.ts:50](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L50) +Defined in: [types/diagnostics.ts:96](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L96) #### Parameters diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/SuppressedValue.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/SuppressedValue.md index 1787495..c7cb9ad 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/SuppressedValue.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/interfaces/SuppressedValue.md @@ -6,7 +6,7 @@ # Interface: SuppressedValue<T> -Defined in: [types/diagnostics.ts:136](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L136) +Defined in: [types/diagnostics.ts:184](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L184) A value wrapped with diagnostic suppression metadata. Created by the `suppress()` function. @@ -23,7 +23,7 @@ Created by the `suppress()` function. > **\[SUPPRESSED\_VALUE\_SYMBOL\]**: `true` -Defined in: [types/diagnostics.ts:137](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L137) +Defined in: [types/diagnostics.ts:185](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L185) *** @@ -31,7 +31,7 @@ Defined in: [types/diagnostics.ts:137](https://github.com/emmanuelnk/github-acti > **suppressions**: `object`[] -Defined in: [types/diagnostics.ts:139](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L139) +Defined in: [types/diagnostics.ts:187](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L187) #### code @@ -39,7 +39,7 @@ Defined in: [types/diagnostics.ts:139](https://github.com/emmanuelnk/github-acti #### reason? -> `optional` **reason**: `string` +> `optional` **reason?**: `string` *** @@ -47,4 +47,4 @@ Defined in: [types/diagnostics.ts:139](https://github.com/emmanuelnk/github-acti > **value**: `T` -Defined in: [types/diagnostics.ts:138](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L138) +Defined in: [types/diagnostics.ts:186](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L186) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/ConfiguredSeverity.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/ConfiguredSeverity.md index 093f987..31c3894 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/ConfiguredSeverity.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/ConfiguredSeverity.md @@ -8,7 +8,7 @@ > **ConfiguredSeverity** = `"off"` \| `"warn"` \| `"error"` -Defined in: [types/diagnostics.ts:21](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L21) +Defined in: [types/diagnostics.ts:21](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L21) Configured severity level for diagnostic rules. - 'off': Suppress the diagnostic entirely diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticRuleConfig.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticRuleConfig.md index c90b864..9c6db7d 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticRuleConfig.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticRuleConfig.md @@ -8,7 +8,7 @@ > **DiagnosticRuleConfig** = [`ConfiguredSeverity`](ConfiguredSeverity.md) \| \{ `exclude?`: `string`[]; `severity?`: [`ConfiguredSeverity`](ConfiguredSeverity.md); \} -Defined in: [types/diagnostics.ts:27](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L27) +Defined in: [types/diagnostics.ts:27](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L27) Configuration for a diagnostic rule. Can be a simple severity string or an object with more options. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticRules.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticRules.md index 0bded6a..efbaa10 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticRules.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticRules.md @@ -8,6 +8,6 @@ > **DiagnosticRules** = `Record`<`string`, [`DiagnosticRuleConfig`](DiagnosticRuleConfig.md)> -Defined in: [types/diagnostics.ts:37](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L37) +Defined in: [types/diagnostics.ts:37](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L37) Map of diagnostic codes to their rule configurations. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticSeverity.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticSeverity.md index b30488d..0ac271a 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticSeverity.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/type-aliases/DiagnosticSeverity.md @@ -8,4 +8,4 @@ > **DiagnosticSeverity** = *typeof* [`DiagnosticSeverity`](../variables/DiagnosticSeverity.md)\[keyof *typeof* [`DiagnosticSeverity`](../variables/DiagnosticSeverity.md)\] -Defined in: [types/diagnostics.ts:3](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L3) +Defined in: [types/diagnostics.ts:3](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L3) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/variables/DiagnosticSeverity.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/variables/DiagnosticSeverity.md index 4dbfc66..b048118 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/variables/DiagnosticSeverity.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/Diagnostics/variables/DiagnosticSeverity.md @@ -8,7 +8,7 @@ > `const` **DiagnosticSeverity**: `object` -Defined in: [types/diagnostics.ts:3](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/diagnostics.ts#L3) +Defined in: [types/diagnostics.ts:3](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/diagnostics.ts#L3) ## Type Declaration diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/ExtendedWorkflowTypes/type-aliases/MatrixConfiguration.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/ExtendedWorkflowTypes/type-aliases/MatrixConfiguration.md index ff95da0..7a7ea3b 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/ExtendedWorkflowTypes/type-aliases/MatrixConfiguration.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/ExtendedWorkflowTypes/type-aliases/MatrixConfiguration.md @@ -8,4 +8,4 @@ > **MatrixConfiguration** = `string` \| \[[`Configuration`](../../GeneratedWorkflowTypes/type-aliases/Configuration.md), `...Configuration[]`\] -Defined in: [types/githubActionsWorkflowExtended.ts:3](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflowExtended.ts#L3) +Defined in: [types/githubActionsWorkflowExtended.ts:3](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflowExtended.ts#L3) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/README.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/README.md index 5267fb0..42c31f9 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/README.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/README.md @@ -14,13 +14,14 @@ These types provide full type safety for workflow configurations. | Interface | Description | | ------ | ------ | | [Concurrency](interfaces/Concurrency.md) | - | -| [Container](interfaces/Container.md) | - | | [Defaults](interfaces/Defaults.md) | A map of default settings that will apply to all jobs in the workflow. | | [Defaults1](interfaces/Defaults1.md) | A map of default settings that will apply to all steps in the job. | | [Environment](interfaces/Environment.md) | The environment that the job references | -| [NormalJob](interfaces/NormalJob.md) | Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace with a string that is unique to the jobs object. The must start with a letter or _ and contain only alphanumeric characters, -, or _. | +| [JobContainer](interfaces/JobContainer.md) | - | +| [NormalJob](interfaces/NormalJob.md) | Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace <job_id> with a string that is unique to the jobs object. The <job_id> must start with a letter or _ and contain only alphanumeric characters, -, or _. | | [PermissionsEvent](interfaces/PermissionsEvent.md) | - | -| [ReusableWorkflowCallJob](interfaces/ReusableWorkflowCallJob.md) | Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace with a string that is unique to the jobs object. The must start with a letter or _ and contain only alphanumeric characters, -, or _. | +| [ReusableWorkflowCallJob](interfaces/ReusableWorkflowCallJob.md) | Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace <job_id> with a string that is unique to the jobs object. The <job_id> must start with a letter or _ and contain only alphanumeric characters, -, or _. | +| [ServiceContainer](interfaces/ServiceContainer.md) | - | | [Workflow](interfaces/Workflow.md) | - | ## Type Aliases @@ -29,51 +30,69 @@ These types provide full type safety for workflow configurations. | ------ | ------ | | [Branch](type-aliases/Branch.md) | 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. 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. The patterns defined in branches and tags are evaluated against the Git ref's name. For example, defining the pattern mona/octocat in branches will match the refs/heads/mona/octocat Git ref. The pattern releases/** will match the refs/heads/releases/10 Git ref. You can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches: - branches or branches-ignore - You cannot use both the branches and branches-ignore filters for the same event in a workflow. Use the branches filter when you need to filter branches for positive matches and exclude branches. Use the branches-ignore filter when you only need to exclude branch names. - tags or tags-ignore - You cannot use both the tags and tags-ignore filters for the same event in a workflow. Use the tags filter when you need to filter tags for positive matches and exclude tags. Use the tags-ignore filter when you only need to exclude tag names. You can exclude tags and branches using the ! character. The order that you define patterns matters. - A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref. - A matching positive pattern after a negative match will include the Git ref again. | | [BranchProtectionRuleEvent](type-aliases/BranchProtectionRuleEvent.md) | Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event. | +| [BranchProtectionRuleEventTypes](type-aliases/BranchProtectionRuleEventTypes.md) | 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. 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. | | [CheckRunEvent](type-aliases/CheckRunEvent.md) | 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. | +| [CheckRunEventTypes](type-aliases/CheckRunEventTypes.md) | 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. 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. | | [CheckSuiteEvent](type-aliases/CheckSuiteEvent.md) | 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/. | +| [CheckSuiteEventTypes](type-aliases/CheckSuiteEventTypes.md) | 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. 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. | | [Configuration](type-aliases/Configuration.md) | - | | [CreateEvent](type-aliases/CreateEvent.md) | 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. | | [DeleteEvent](type-aliases/DeleteEvent.md) | 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. | | [DeploymentEvent](type-aliases/DeploymentEvent.md) | 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/. | | [DeploymentStatusEvent](type-aliases/DeploymentStatusEvent.md) | 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. | | [DiscussionCommentEvent](type-aliases/DiscussionCommentEvent.md) | 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 | +| [DiscussionCommentEventTypes](type-aliases/DiscussionCommentEventTypes.md) | 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. 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. | | [DiscussionEvent](type-aliases/DiscussionEvent.md) | 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 | +| [DiscussionEventTypes](type-aliases/DiscussionEventTypes.md) | 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. 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. | | [Env](type-aliases/Env.md) | A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case. | -| [Env1](type-aliases/Env1.md) | To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs..steps[*].env, jobs..env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv | +| [Env1](type-aliases/Env1.md) | To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv | | [Event](type-aliases/Event.md) | This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file. | | [ExpressionSyntax](type-aliases/ExpressionSyntax.md) | - | | [ForkEvent](type-aliases/ForkEvent.md) | 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. | | [GollumEvent](type-aliases/GollumEvent.md) | Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. | | [IssueCommentEvent](type-aliases/IssueCommentEvent.md) | 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/. | +| [IssueCommentEventTypes](type-aliases/IssueCommentEventTypes.md) | 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. 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. | | [IssuesEvent](type-aliases/IssuesEvent.md) | 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. | +| [IssuesEventTypes](type-aliases/IssuesEventTypes.md) | 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. 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. | | [JobNeeds](type-aliases/JobNeeds.md) | Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue. | | [LabelEvent](type-aliases/LabelEvent.md) | 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/. | +| [LabelEventTypes](type-aliases/LabelEventTypes.md) | 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. 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. | | [Matrix](type-aliases/Matrix.md) | A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status. You can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix. When you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. | | [MergeGroupEvent](type-aliases/MergeGroupEvent.md) | 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 . | +| [MergeGroupEventTypes](type-aliases/MergeGroupEventTypes.md) | 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. 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. | | [MilestoneEvent](type-aliases/MilestoneEvent.md) | 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/. | +| [MilestoneEventTypes](type-aliases/MilestoneEventTypes.md) | 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. 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. | | [Name](type-aliases/Name.md) | - | | [PageBuildEvent](type-aliases/PageBuildEvent.md) | 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/. | | [Path](type-aliases/Path.md) | When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. Path filters are not evaluated for pushes to tags. The paths-ignore and paths keywords accept glob patterns that use the * and ** wildcard characters to match more than one path 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. You can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow. - paths-ignore - Use the paths-ignore filter when you only need to exclude path names. - paths - Use the paths filter when you need to filter paths for positive matches and exclude paths. | | [Permissions](type-aliases/Permissions.md) | You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access. | | [PermissionsLevel](type-aliases/PermissionsLevel.md) | - | | [ProjectCardEvent](type-aliases/ProjectCardEvent.md) | 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. | +| [ProjectCardEventTypes](type-aliases/ProjectCardEventTypes.md) | 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. 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. | | [ProjectColumnEvent](type-aliases/ProjectColumnEvent.md) | 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. | +| [ProjectColumnEventTypes](type-aliases/ProjectColumnEventTypes.md) | 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. 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. | | [ProjectEvent](type-aliases/ProjectEvent.md) | 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/. | +| [ProjectEventTypes](type-aliases/ProjectEventTypes.md) | 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. 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. | | [PublicEvent](type-aliases/PublicEvent.md) | 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. | | [PullRequestEventTypes](type-aliases/PullRequestEventTypes.md) | 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. 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. | | [PullRequestReviewCommentEvent](type-aliases/PullRequestReviewCommentEvent.md) | 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. Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. 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. | +| [PullRequestReviewCommentEventTypes](type-aliases/PullRequestReviewCommentEventTypes.md) | 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. 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. | | [PullRequestReviewEvent](type-aliases/PullRequestReviewEvent.md) | Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews. Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. 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. | +| [PullRequestReviewEventTypes](type-aliases/PullRequestReviewEventTypes.md) | 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. 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. | | [PullRequestTargetEventTypes](type-aliases/PullRequestTargetEventTypes.md) | 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. 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. | | [RegistryPackageEvent](type-aliases/RegistryPackageEvent.md) | 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. | +| [RegistryPackageEventTypes](type-aliases/RegistryPackageEventTypes.md) | 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. 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. | | [ReleaseEvent](type-aliases/ReleaseEvent.md) | 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. | +| [ReleaseEventTypes](type-aliases/ReleaseEventTypes.md) | 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. 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. | | [RepositoryDispatchEvent](type-aliases/RepositoryDispatchEvent.md) | 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. 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. | | [Shell](type-aliases/Shell.md) | 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. | -| [Snapshot](type-aliases/Snapshot.md) | You can use `jobs..snapshot` to generate a custom image. Add the snapshot keyword to the job, using either the string syntax or mapping syntax as shown in https://docs.github.com/en/actions/how-tos/manage-runners/larger-runners/use-custom-images#generating-a-custom-image. Each job that includes the snapshot keyword creates a separate image. To generate only one image or image version, include all workflow steps in a single job. Each successful run of a job that includes the snapshot keyword creates a new version of that image. For more information, see https://docs.github.com/en/actions/how-tos/manage-runners/larger-runners/use-custom-images. | +| [Snapshot](type-aliases/Snapshot.md) | You can use `jobs.<job_id>.snapshot` to generate a custom image. Add the snapshot keyword to the job, using either the string syntax or mapping syntax as shown in https://docs.github.com/en/actions/how-tos/manage-runners/larger-runners/use-custom-images#generating-a-custom-image. Each job that includes the snapshot keyword creates a separate image. To generate only one image or image version, include all workflow steps in a single job. Each successful run of a job that includes the snapshot keyword creates a new version of that image. For more information, see https://docs.github.com/en/actions/how-tos/manage-runners/larger-runners/use-custom-images. | | [StatusEvent](type-aliases/StatusEvent.md) | 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/. | | [Step](type-aliases/Step.md) | - | | [Step1](type-aliases/Step1.md) | - | | [StringContainingExpressionSyntax](type-aliases/StringContainingExpressionSyntax.md) | - | | [WatchEvent](type-aliases/WatchEvent.md) | 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/. | -| [WorkflowDispatchInput](type-aliases/WorkflowDispatchInput.md) | A string identifier to associate with the input. The value of is a map of the input's metadata. The must be a unique identifier within the inputs object. The must start with a letter or _ and contain only alphanumeric characters, -, or _. | +| [WorkflowDispatchInput](type-aliases/WorkflowDispatchInput.md) | 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 _. | | [WorkflowRunEvent](type-aliases/WorkflowRunEvent.md) | 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. | +| [WorkflowRunEventTypes](type-aliases/WorkflowRunEventTypes.md) | 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. 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. | | [WorkingDirectory](type-aliases/WorkingDirectory.md) | Using the working-directory keyword, you can specify the working directory of where to run the command. | diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Concurrency.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Concurrency.md index f1e370c..21a847b 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Concurrency.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Concurrency.md @@ -6,15 +6,15 @@ # Interface: Concurrency -Defined in: [types/githubActionsWorkflow.ts:757](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L757) +Defined in: [types/githubActionsWorkflow.ts:1139](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1139) ## Properties ### cancel-in-progress? -> `optional` **cancel-in-progress**: `string` \| `boolean` +> `optional` **cancel-in-progress?**: `string` \| `boolean` -Defined in: [types/githubActionsWorkflow.ts:765](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L765) +Defined in: [types/githubActionsWorkflow.ts:1147](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1147) To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. @@ -24,6 +24,16 @@ To cancel any currently running job or workflow in the same concurrency group, s > **group**: `string` -Defined in: [types/githubActionsWorkflow.ts:761](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L761) +Defined in: [types/githubActionsWorkflow.ts:1143](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1143) -When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. +When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. By default any previously pending job or workflow in the concurrency group will be canceled; this behavior can be changed with `queue`. + +*** + +### queue? + +> `optional` **queue?**: `"single"` \| `"max"` + +Defined in: [types/githubActionsWorkflow.ts:1151](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1151) + +Controls how pending jobs or workflow runs are queued within a concurrency group. With the default `single`, at most one run can be pending — additional pending runs cancel the previous one. With `max`, up to 100 runs can be pending and are processed in FIFO order. The combination of `queue: max` and `cancel-in-progress: true` is not allowed. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Container.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Container.md deleted file mode 100644 index 0f82c12..0000000 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Container.md +++ /dev/null @@ -1,83 +0,0 @@ -[**@github-actions-workflow-ts/lib**](../../../../README.md) - -*** - -[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / Container - -# Interface: Container - -Defined in: [types/githubActionsWorkflow.ts:904](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L904) - -## Properties - -### credentials? - -> `optional` **credentials**: `object` - -Defined in: [types/githubActionsWorkflow.ts:912](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L912) - -If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the `docker login` command. - -#### Index Signature - -\[`k`: `string`\]: `unknown` - -#### password? - -> `optional` **password**: `string` - -#### username? - -> `optional` **username**: `string` - -*** - -### env? - -> `optional` **env**: `string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} - -Defined in: [types/githubActionsWorkflow.ts:920](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L920) - -Sets an array of environment variables in the container. - -*** - -### image - -> **image**: `string` - -Defined in: [types/githubActionsWorkflow.ts:908](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L908) - -The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name. - -*** - -### options? - -> `optional` **options**: `string` - -Defined in: [types/githubActionsWorkflow.ts:940](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L940) - -Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options. - -*** - -### ports? - -> `optional` **ports**: \[`string` \| `number`, ...(string \| number)\[\]\] - -Defined in: [types/githubActionsWorkflow.ts:929](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L929) - -Sets an array of ports to expose on the container. - -*** - -### volumes? - -> `optional` **volumes**: \[`string`, `...string[]`\] - -Defined in: [types/githubActionsWorkflow.ts:936](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L936) - -Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. -To specify a volume, you specify the source and destination path: \:\ -The \ is a volume name or an absolute path on the host machine, and \ is an absolute path in the container. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Defaults.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Defaults.md index 401b691..ffdd8d3 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Defaults.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Defaults.md @@ -6,7 +6,7 @@ # Interface: Defaults -Defined in: [types/githubActionsWorkflow.ts:751](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L751) +Defined in: [types/githubActionsWorkflow.ts:1133](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1133) A map of default settings that will apply to all jobs in the workflow. @@ -14,14 +14,14 @@ A map of default settings that will apply to all jobs in the workflow. ### run? -> `optional` **run**: `object` +> `optional` **run?**: `object` -Defined in: [types/githubActionsWorkflow.ts:752](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L752) +Defined in: [types/githubActionsWorkflow.ts:1134](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1134) #### shell? -> `optional` **shell**: `string` +> `optional` **shell?**: `string` #### working-directory? -> `optional` **working-directory**: `string` +> `optional` **working-directory?**: `string` diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Defaults1.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Defaults1.md index 417ee8a..57714e9 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Defaults1.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Defaults1.md @@ -6,7 +6,7 @@ # Interface: Defaults1 -Defined in: [types/githubActionsWorkflow.ts:898](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L898) +Defined in: [types/githubActionsWorkflow.ts:1290](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1290) A map of default settings that will apply to all steps in the job. @@ -14,14 +14,14 @@ A map of default settings that will apply to all steps in the job. ### run? -> `optional` **run**: `object` +> `optional` **run?**: `object` -Defined in: [types/githubActionsWorkflow.ts:899](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L899) +Defined in: [types/githubActionsWorkflow.ts:1291](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1291) #### shell? -> `optional` **shell**: `string` +> `optional` **shell?**: `string` #### working-directory? -> `optional` **working-directory**: `string` +> `optional` **working-directory?**: `string` diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Environment.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Environment.md index 5af6776..30a4f74 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Environment.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Environment.md @@ -6,17 +6,27 @@ # Interface: Environment -Defined in: [types/githubActionsWorkflow.ts:885](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L885) +Defined in: [types/githubActionsWorkflow.ts:1273](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1273) The environment that the job references ## Properties +### deployment? + +> `optional` **deployment?**: `string` \| `boolean` + +Defined in: [types/githubActionsWorkflow.ts:1285](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1285) + +Whether to create a deployment for this job. Setting to false lets the job use environment secrets and variables without creating a deployment record. Wait timers and required reviewers still apply. + +*** + ### name > **name**: `string` -Defined in: [types/githubActionsWorkflow.ts:889](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L889) +Defined in: [types/githubActionsWorkflow.ts:1277](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1277) The name of the environment configured in the repo. @@ -24,8 +34,8 @@ The name of the environment configured in the repo. ### url? -> `optional` **url**: `string` +> `optional` **url?**: `string` -Defined in: [types/githubActionsWorkflow.ts:893](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L893) +Defined in: [types/githubActionsWorkflow.ts:1281](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1281) A deployment URL diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/JobContainer.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/JobContainer.md new file mode 100644 index 0000000..d5af6fb --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/JobContainer.md @@ -0,0 +1,83 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / JobContainer + +# Interface: JobContainer + +Defined in: [types/githubActionsWorkflow.ts:1296](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1296) + +## Properties + +### credentials? + +> `optional` **credentials?**: `object` + +Defined in: [types/githubActionsWorkflow.ts:1304](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1304) + +If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the `docker login` command. + +#### Index Signature + +\[`k`: `string`\]: `unknown` + +#### password? + +> `optional` **password?**: `string` + +#### username? + +> `optional` **username?**: `string` + +*** + +### env? + +> `optional` **env?**: `string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} + +Defined in: [types/githubActionsWorkflow.ts:1312](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1312) + +Sets a map of environment variables in the container. + +*** + +### image + +> **image**: `string` + +Defined in: [types/githubActionsWorkflow.ts:1300](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1300) + +The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name. + +*** + +### options? + +> `optional` **options?**: `string` + +Defined in: [types/githubActionsWorkflow.ts:1332](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1332) + +Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options. + +*** + +### ports? + +> `optional` **ports?**: \[`string` \| `number`, ...(string \| number)\[\]\] + +Defined in: [types/githubActionsWorkflow.ts:1321](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1321) + +Sets an array of ports to expose on the container. + +*** + +### volumes? + +> `optional` **volumes?**: \[`string`, `...string[]`\] + +Defined in: [types/githubActionsWorkflow.ts:1328](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1328) + +Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. +To specify a volume, you specify the source and destination path: \:\ +The \ is a volume name or an absolute path on the host machine, and \ is an absolute path in the container. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/NormalJob.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/NormalJob.md index 2a18a6d..dea1c5a 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/NormalJob.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/NormalJob.md @@ -6,7 +6,7 @@ # Interface: NormalJob -Defined in: [types/githubActionsWorkflow.ts:770](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L770) +Defined in: [types/githubActionsWorkflow.ts:1156](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1156) Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace \ with a string that is unique to the jobs object. The \ must start with a letter or _ and contain only alphanumeric characters, -, or _. @@ -14,21 +14,21 @@ Each job must have an id to associate with the job. The key job_id is a string a ### concurrency? -> `optional` **concurrency**: `string` \| [`Concurrency`](Concurrency.md) +> `optional` **concurrency?**: `string` \| [`Concurrency`](Concurrency.md) -Defined in: [types/githubActionsWorkflow.ts:863](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L863) +Defined in: [types/githubActionsWorkflow.ts:1249](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1249) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. You can also specify concurrency at the workflow level. -When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. +When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. By default any previously pending job or workflow in the concurrency group will be canceled; this behavior can be changed with `queue`. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. *** ### container? -> `optional` **container**: `string` \| [`Container`](Container.md) +> `optional` **container?**: `string` \| [`JobContainer`](JobContainer.md) -Defined in: [types/githubActionsWorkflow.ts:848](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L848) +Defined in: [types/githubActionsWorkflow.ts:1234](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1234) A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts. If you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container. @@ -37,9 +37,9 @@ If you do not set a container, all steps will run directly on the host specified ### continue-on-error? -> `optional` **continue-on-error**: `string` \| `boolean` +> `optional` **continue-on-error?**: `string` \| `boolean` -Defined in: [types/githubActionsWorkflow.ts:843](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L843) +Defined in: [types/githubActionsWorkflow.ts:1229](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1229) Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails. @@ -47,17 +47,17 @@ Prevents a workflow run from failing when a job fails. Set to true to allow a wo ### defaults? -> `optional` **defaults**: [`Defaults1`](Defaults1.md) +> `optional` **defaults?**: [`Defaults1`](Defaults1.md) -Defined in: [types/githubActionsWorkflow.ts:809](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L809) +Defined in: [types/githubActionsWorkflow.ts:1195](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1195) *** ### env? -> `optional` **env**: `string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} +> `optional` **env?**: `string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} -Defined in: [types/githubActionsWorkflow.ts:804](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L804) +Defined in: [types/githubActionsWorkflow.ts:1190](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1190) To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.\.steps[*].env, jobs.\.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv @@ -65,9 +65,9 @@ To set custom environment variables, you need to specify the variables in the wo ### environment? -> `optional` **environment**: `string` \| [`Environment`](Environment.md) +> `optional` **environment?**: `string` \| [`Environment`](Environment.md) -Defined in: [types/githubActionsWorkflow.ts:794](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L794) +Defined in: [types/githubActionsWorkflow.ts:1180](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1180) The environment that the job references. @@ -75,9 +75,9 @@ The environment that the job references. ### if? -> `optional` **if**: `string` \| `number` \| `boolean` +> `optional` **if?**: `string` \| `number` \| `boolean` -Defined in: [types/githubActionsWorkflow.ts:814](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L814) +Defined in: [types/githubActionsWorkflow.ts:1200](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1200) You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional. Expressions in an if conditional do not require the $\{\{ \}\} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. @@ -86,9 +86,9 @@ Expressions in an if conditional do not require the $\{\{ \}\} syntax. For more ### name? -> `optional` **name**: `string` +> `optional` **name?**: `string` -Defined in: [types/githubActionsWorkflow.ts:774](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L774) +Defined in: [types/githubActionsWorkflow.ts:1160](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1160) The name of the job displayed on GitHub. @@ -96,17 +96,17 @@ The name of the job displayed on GitHub. ### needs? -> `optional` **needs**: [`JobNeeds`](../type-aliases/JobNeeds.md) +> `optional` **needs?**: [`JobNeeds`](../type-aliases/JobNeeds.md) -Defined in: [types/githubActionsWorkflow.ts:775](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L775) +Defined in: [types/githubActionsWorkflow.ts:1161](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1161) *** ### outputs? -> `optional` **outputs**: `object` +> `optional` **outputs?**: `object` -Defined in: [types/githubActionsWorkflow.ts:798](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L798) +Defined in: [types/githubActionsWorkflow.ts:1184](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1184) A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job. @@ -118,9 +118,9 @@ A map of outputs for a job. Job outputs are available to all downstream jobs tha ### permissions? -> `optional` **permissions**: [`Permissions`](../type-aliases/Permissions.md) +> `optional` **permissions?**: [`Permissions`](../type-aliases/Permissions.md) -Defined in: [types/githubActionsWorkflow.ts:777](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L777) +Defined in: [types/githubActionsWorkflow.ts:1163](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1163) *** @@ -128,7 +128,7 @@ Defined in: [types/githubActionsWorkflow.ts:777](https://github.com/emmanuelnk/g > **runs-on**: `string` \| \[`string`, `...string[]`\] & `unknown`[] \| \{\[`k`: `string`\]: `unknown`; `group?`: `string`; `labels?`: `string` \| `string`[]; \} -Defined in: [types/githubActionsWorkflow.ts:781](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L781) +Defined in: [types/githubActionsWorkflow.ts:1167](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1167) The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner. @@ -136,9 +136,9 @@ The type of machine to run the job on. The machine can be either a GitHub-hosted ### services? -> `optional` **services**: `object` +> `optional` **services?**: `object` -Defined in: [types/githubActionsWorkflow.ts:855](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L855) +Defined in: [types/githubActionsWorkflow.ts:1241](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1241) Additional containers to host services for a job in a workflow. These are useful for creating databases or cache services like redis. The runner on the virtual machine will automatically create a network and manage the life cycle of the service containers. When you use a service container for a job or your step uses container actions, you don't need to set port information to access the service. Docker automatically exposes all ports between containers on the same network. @@ -147,23 +147,23 @@ When a step does not use a container action, you must access the service using l #### Index Signature -\[`k`: `string`\]: [`Container`](Container.md) +\[`k`: `string`\]: [`ServiceContainer`](ServiceContainer.md) *** ### snapshot? -> `optional` **snapshot**: [`Snapshot`](../type-aliases/Snapshot.md) +> `optional` **snapshot?**: [`Snapshot`](../type-aliases/Snapshot.md) -Defined in: [types/githubActionsWorkflow.ts:776](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L776) +Defined in: [types/githubActionsWorkflow.ts:1162](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1162) *** ### steps? -> `optional` **steps**: \[[`Step`](../type-aliases/Step.md), `...Step[]`\] +> `optional` **steps?**: \[[`Step`](../type-aliases/Step.md), `...Step[]`\] -Defined in: [types/githubActionsWorkflow.ts:821](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L821) +Defined in: [types/githubActionsWorkflow.ts:1207](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1207) A job contains a sequence of tasks called steps. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the virtual environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job. Must contain either `uses` or `run` @@ -172,15 +172,15 @@ Must contain either `uses` or `run` ### strategy? -> `optional` **strategy**: `object` +> `optional` **strategy?**: `object` -Defined in: [types/githubActionsWorkflow.ts:829](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L829) +Defined in: [types/githubActionsWorkflow.ts:1215](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1215) A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in. #### fail-fast? -> `optional` **fail-fast**: `string` \| `boolean` +> `optional` **fail-fast?**: `string` \| `boolean` When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true @@ -190,7 +190,7 @@ When set to true, GitHub cancels all in-progress jobs if any matrix job fails. D #### max-parallel? -> `optional` **max-parallel**: `string` \| `number` +> `optional` **max-parallel?**: `string` \| `number` The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines. @@ -198,8 +198,8 @@ The maximum number of jobs that can run simultaneously when using a matrix job s ### timeout-minutes? -> `optional` **timeout-minutes**: `string` \| `number` +> `optional` **timeout-minutes?**: `string` \| `number` -Defined in: [types/githubActionsWorkflow.ts:825](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L825) +Defined in: [types/githubActionsWorkflow.ts:1211](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1211) The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360 diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/PermissionsEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/PermissionsEvent.md index 1c68aff..2385138 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/PermissionsEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/PermissionsEvent.md @@ -6,124 +6,140 @@ # Interface: PermissionsEvent -Defined in: [types/githubActionsWorkflow.ts:865](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L865) +Defined in: [types/githubActionsWorkflow.ts:1251](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1251) ## Properties ### actions? -> `optional` **actions**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **actions?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:866](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L866) +Defined in: [types/githubActionsWorkflow.ts:1252](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1252) + +*** + +### artifact-metadata? + +> `optional` **artifact-metadata?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) + +Defined in: [types/githubActionsWorkflow.ts:1253](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1253) *** ### attestations? -> `optional` **attestations**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **attestations?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:867](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L867) +Defined in: [types/githubActionsWorkflow.ts:1254](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1254) *** ### checks? -> `optional` **checks**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **checks?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) + +Defined in: [types/githubActionsWorkflow.ts:1255](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1255) + +*** + +### code-quality? + +> `optional` **code-quality?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:868](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L868) +Defined in: [types/githubActionsWorkflow.ts:1256](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1256) *** ### contents? -> `optional` **contents**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **contents?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:869](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L869) +Defined in: [types/githubActionsWorkflow.ts:1257](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1257) *** ### deployments? -> `optional` **deployments**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **deployments?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:870](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L870) +Defined in: [types/githubActionsWorkflow.ts:1258](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1258) *** ### discussions? -> `optional` **discussions**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **discussions?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:871](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L871) +Defined in: [types/githubActionsWorkflow.ts:1259](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1259) *** ### id-token? -> `optional` **id-token**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **id-token?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:872](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L872) +Defined in: [types/githubActionsWorkflow.ts:1260](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1260) *** ### issues? -> `optional` **issues**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **issues?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:873](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L873) +Defined in: [types/githubActionsWorkflow.ts:1261](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1261) *** ### models? -> `optional` **models**: `"read"` \| `"none"` +> `optional` **models?**: `"read"` \| `"none"` -Defined in: [types/githubActionsWorkflow.ts:874](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L874) +Defined in: [types/githubActionsWorkflow.ts:1262](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1262) *** ### packages? -> `optional` **packages**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **packages?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:875](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L875) +Defined in: [types/githubActionsWorkflow.ts:1263](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1263) *** ### pages? -> `optional` **pages**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **pages?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:876](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L876) +Defined in: [types/githubActionsWorkflow.ts:1264](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1264) *** ### pull-requests? -> `optional` **pull-requests**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **pull-requests?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:877](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L877) +Defined in: [types/githubActionsWorkflow.ts:1265](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1265) *** ### repository-projects? -> `optional` **repository-projects**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **repository-projects?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:878](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L878) +Defined in: [types/githubActionsWorkflow.ts:1266](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1266) *** ### security-events? -> `optional` **security-events**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **security-events?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:879](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L879) +Defined in: [types/githubActionsWorkflow.ts:1267](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1267) *** ### statuses? -> `optional` **statuses**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) +> `optional` **statuses?**: [`PermissionsLevel`](../type-aliases/PermissionsLevel.md) -Defined in: [types/githubActionsWorkflow.ts:880](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L880) +Defined in: [types/githubActionsWorkflow.ts:1268](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1268) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/ReusableWorkflowCallJob.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/ReusableWorkflowCallJob.md index 580504c..47528d5 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/ReusableWorkflowCallJob.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/ReusableWorkflowCallJob.md @@ -6,7 +6,7 @@ # Interface: ReusableWorkflowCallJob -Defined in: [types/githubActionsWorkflow.ts:945](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L945) +Defined in: [types/githubActionsWorkflow.ts:1383](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1383) Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace \ with a string that is unique to the jobs object. The \ must start with a letter or _ and contain only alphanumeric characters, -, or _. @@ -14,21 +14,21 @@ Each job must have an id to associate with the job. The key job_id is a string a ### concurrency? -> `optional` **concurrency**: `string` \| [`Concurrency`](Concurrency.md) +> `optional` **concurrency?**: `string` \| [`Concurrency`](Concurrency.md) -Defined in: [types/githubActionsWorkflow.ts:992](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L992) +Defined in: [types/githubActionsWorkflow.ts:1430](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1430) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. You can also specify concurrency at the workflow level. -When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. +When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. By default any previously pending job or workflow in the concurrency group will be canceled; this behavior can be changed with `queue`. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. *** ### if? -> `optional` **if**: `string` \| `number` \| `boolean` +> `optional` **if?**: `string` \| `number` \| `boolean` -Defined in: [types/githubActionsWorkflow.ts:956](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L956) +Defined in: [types/githubActionsWorkflow.ts:1394](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1394) You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional. Expressions in an if conditional do not require the $\{\{ \}\} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. @@ -37,9 +37,9 @@ Expressions in an if conditional do not require the $\{\{ \}\} syntax. For more ### name? -> `optional` **name**: `string` +> `optional` **name?**: `string` -Defined in: [types/githubActionsWorkflow.ts:949](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L949) +Defined in: [types/githubActionsWorkflow.ts:1387](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1387) The name of the job displayed on GitHub. @@ -47,25 +47,25 @@ The name of the job displayed on GitHub. ### needs? -> `optional` **needs**: [`JobNeeds`](../type-aliases/JobNeeds.md) +> `optional` **needs?**: [`JobNeeds`](../type-aliases/JobNeeds.md) -Defined in: [types/githubActionsWorkflow.ts:950](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L950) +Defined in: [types/githubActionsWorkflow.ts:1388](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1388) *** ### permissions? -> `optional` **permissions**: [`Permissions`](../type-aliases/Permissions.md) +> `optional` **permissions?**: [`Permissions`](../type-aliases/Permissions.md) -Defined in: [types/githubActionsWorkflow.ts:951](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L951) +Defined in: [types/githubActionsWorkflow.ts:1389](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1389) *** ### secrets? -> `optional` **secrets**: [`Env1`](../type-aliases/Env1.md) +> `optional` **secrets?**: [`Env1`](../type-aliases/Env1.md) -Defined in: [types/githubActionsWorkflow.ts:972](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L972) +Defined in: [types/githubActionsWorkflow.ts:1410](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1410) When a job is used to call a reusable workflow, you can use 'secrets' to provide a map of secrets that are passed to the called workflow. Any secrets that you pass must match the names defined in the called workflow. @@ -73,15 +73,15 @@ When a job is used to call a reusable workflow, you can use 'secrets' to provide ### strategy? -> `optional` **strategy**: `object` +> `optional` **strategy?**: `object` -Defined in: [types/githubActionsWorkflow.ts:976](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L976) +Defined in: [types/githubActionsWorkflow.ts:1414](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1414) A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in. #### fail-fast? -> `optional` **fail-fast**: `string` \| `boolean` +> `optional` **fail-fast?**: `string` \| `boolean` When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true @@ -91,7 +91,7 @@ When set to true, GitHub cancels all in-progress jobs if any matrix job fails. D #### max-parallel? -> `optional` **max-parallel**: `string` \| `number` +> `optional` **max-parallel?**: `string` \| `number` The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines. @@ -101,7 +101,7 @@ The maximum number of jobs that can run simultaneously when using a matrix job s > **uses**: `string` -Defined in: [types/githubActionsWorkflow.ts:960](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L960) +Defined in: [types/githubActionsWorkflow.ts:1398](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1398) The location and version of a reusable workflow file to run as a job, of the form './\{path/to\}/\{localfile\}.yml' or '\{owner\}/\{repo\}/\{path\}/\{filename\}@\{ref\}'. \{ref\} can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security. @@ -109,8 +109,8 @@ The location and version of a reusable workflow file to run as a job, of the for ### with? -> `optional` **with**: `string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} +> `optional` **with?**: `string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} -Defined in: [types/githubActionsWorkflow.ts:964](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L964) +Defined in: [types/githubActionsWorkflow.ts:1402](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1402) A map of inputs that are passed to the called workflow. Any inputs that you pass must match the input specifications defined in the called workflow. Unlike 'jobs.\.steps[*].with', the inputs you pass with 'jobs.\.with' are not be available as environment variables in the called workflow. Instead, you can reference the inputs by using the inputs context. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/ServiceContainer.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/ServiceContainer.md new file mode 100644 index 0000000..01fcc5b --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/ServiceContainer.md @@ -0,0 +1,103 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / ServiceContainer + +# Interface: ServiceContainer + +Defined in: [types/githubActionsWorkflow.ts:1334](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1334) + +## Properties + +### command? + +> `optional` **command?**: `string` + +Defined in: [types/githubActionsWorkflow.ts:1374](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1374) + +Overrides the Docker image's default command (`CMD`). The value is passed as arguments after the image name in the `docker create` command. If you also specify `entrypoint`, `command` provides the arguments to that entrypoint. + +*** + +### credentials? + +> `optional` **credentials?**: `object` + +Defined in: [types/githubActionsWorkflow.ts:1342](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1342) + +If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the `docker login` command. + +#### Index Signature + +\[`k`: `string`\]: `unknown` + +#### password? + +> `optional` **password?**: `string` + +#### username? + +> `optional` **username?**: `string` + +*** + +### entrypoint? + +> `optional` **entrypoint?**: `string` + +Defined in: [types/githubActionsWorkflow.ts:1378](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1378) + +Overrides the Docker image's default `ENTRYPOINT`. The value is a single string defining the executable to run. Use this when you need to replace the image's entrypoint entirely. You can combine `entrypoint` with `command` to pass arguments to the custom entrypoint. + +*** + +### env? + +> `optional` **env?**: `string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} + +Defined in: [types/githubActionsWorkflow.ts:1350](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1350) + +Sets a map of environment variables in the service container. + +*** + +### image + +> **image**: `string` + +Defined in: [types/githubActionsWorkflow.ts:1338](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1338) + +The Docker image to use as the service container to run the action. The value can be the Docker Hub image name or a registry name. + +*** + +### options? + +> `optional` **options?**: `string` + +Defined in: [types/githubActionsWorkflow.ts:1370](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1370) + +Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options. + +*** + +### ports? + +> `optional` **ports?**: \[`string` \| `number`, ...(string \| number)\[\]\] + +Defined in: [types/githubActionsWorkflow.ts:1359](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1359) + +Sets an array of ports to expose on the service container. + +*** + +### volumes? + +> `optional` **volumes?**: \[`string`, `...string[]`\] + +Defined in: [types/githubActionsWorkflow.ts:1366](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1366) + +Sets an array of volumes for the service container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. +To specify a volume, you specify the source and destination path: \:\ +The \ is a volume name or an absolute path on the host machine, and \ is an absolute path in the container. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Workflow.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Workflow.md index e9b4c43..9f2a0d5 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Workflow.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Workflow.md @@ -6,35 +6,35 @@ # Interface: Workflow -Defined in: [types/githubActionsWorkflow.ts:519](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L519) +Defined in: [types/githubActionsWorkflow.ts:887](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L887) ## Properties ### concurrency? -> `optional` **concurrency**: `string` \| [`Concurrency`](Concurrency.md) +> `optional` **concurrency?**: `string` \| [`Concurrency`](Concurrency.md) -Defined in: [types/githubActionsWorkflow.ts:729](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L729) +Defined in: [types/githubActionsWorkflow.ts:1111](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1111) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. You can also specify concurrency at the workflow level. -When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. +When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. By default any previously pending job or workflow in the concurrency group will be canceled; this behavior can be changed with `queue`. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true. *** ### defaults? -> `optional` **defaults**: [`Defaults`](Defaults.md) +> `optional` **defaults?**: [`Defaults`](Defaults.md) -Defined in: [types/githubActionsWorkflow.ts:723](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L723) +Defined in: [types/githubActionsWorkflow.ts:1105](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1105) *** ### env? -> `optional` **env**: `string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} +> `optional` **env?**: `string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} -Defined in: [types/githubActionsWorkflow.ts:718](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L718) +Defined in: [types/githubActionsWorkflow.ts:1100](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1100) To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.\.steps[*].env, jobs.\.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv @@ -44,7 +44,7 @@ To set custom environment variables, you need to specify the variables in the wo > **jobs**: `object` -Defined in: [types/githubActionsWorkflow.ts:735](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L735) +Defined in: [types/githubActionsWorkflow.ts:1117](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1117) A workflow run is made up of one or more jobs. Jobs run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the jobs.\.needs keyword. Each job runs in a fresh instance of the virtual environment specified by runs-on. @@ -61,9 +61,9 @@ via the `patternProperty` "^[_a-zA-Z][a-zA-Z0-9_-]*$". ### name? -> `optional` **name**: `string` +> `optional` **name?**: `string` -Defined in: [types/githubActionsWorkflow.ts:523](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L523) +Defined in: [types/githubActionsWorkflow.ts:891](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L891) The name of your workflow. GitHub displays the names of your workflows on your repository's actions page. If you omit this field, GitHub sets the name to the workflow's filename. @@ -71,107 +71,113 @@ The name of your workflow. GitHub displays the names of your workflows on your r ### on -> **on**: [`Event`](../type-aliases/Event.md) \| \[[`Event`](../type-aliases/Event.md), `...Event[]`\] \| \{ `branch_protection_rule?`: BranchProtectionRuleEvent \| undefined; `check_run?`: CheckRunEvent \| undefined; `check_suite?`: CheckSuiteEvent \| undefined; `create?`: CreateEvent \| undefined; `delete?`: DeleteEvent \| undefined; `deployment?`: DeploymentEvent \| undefined; `deployment_status?`: DeploymentStatusEvent \| undefined; `discussion?`: DiscussionEvent \| undefined; `discussion_comment?`: DiscussionCommentEvent \| undefined; `fork?`: ForkEvent \| undefined; `gollum?`: GollumEvent \| undefined; `issue_comment?`: IssueCommentEvent \| undefined; `issues?`: IssuesEvent \| undefined; `label?`: LabelEvent \| undefined; `merge_group?`: MergeGroupEvent \| undefined; `milestone?`: MilestoneEvent \| undefined; `page_build?`: PageBuildEvent \| undefined; `project?`: ProjectEvent \| undefined; `project_card?`: ProjectCardEvent \| undefined; `project_column?`: ProjectColumnEvent \| undefined; `public?`: PublicEvent \| undefined; `pull_request?`: `object` & `object` \| `null`; `pull_request_review?`: PullRequestReviewEvent \| undefined; `pull_request_review_comment?`: PullRequestReviewCommentEvent \| undefined; `pull_request_target?`: `object` & `object` \| `null`; `push?`: `object` & `object` \| `null`; `registry_package?`: RegistryPackageEvent \| undefined; `release?`: ReleaseEvent \| undefined; `repository_dispatch?`: RepositoryDispatchEvent \| undefined; `schedule?`: \[\{ `cron?`: `string`; \}, `...{ cron?: string }[]`\]; `status?`: StatusEvent \| undefined; `watch?`: WatchEvent \| undefined; `workflow_call?`: \{\[`k`: `string`\]: `unknown`; `inputs?`: \{\[`k`: `string`\]: `object`; \}; `outputs?`: \{\[`k`: `string`\]: `object`; \}; `secrets?`: \{\[`k`: `string`\]: `object`; \}; \}; `workflow_dispatch?`: \{ `inputs?`: \{\[`k`: `string`\]: [`WorkflowDispatchInput`](../type-aliases/WorkflowDispatchInput.md); \}; \}; `workflow_run?`: WorkflowRunEvent \| undefined; \} +> **on**: [`Event`](../type-aliases/Event.md) \| \[[`Event`](../type-aliases/Event.md), `...Event[]`\] \| \{ `branch_protection_rule?`: BranchProtectionRuleEvent \| undefined; `check_run?`: CheckRunEvent \| undefined; `check_suite?`: CheckSuiteEvent \| undefined; `create?`: CreateEvent \| undefined; `delete?`: DeleteEvent \| undefined; `deployment?`: DeploymentEvent \| undefined; `deployment_status?`: DeploymentStatusEvent \| undefined; `discussion?`: DiscussionEvent \| undefined; `discussion_comment?`: DiscussionCommentEvent \| undefined; `fork?`: ForkEvent \| undefined; `gollum?`: GollumEvent \| undefined; `issue_comment?`: IssueCommentEvent \| undefined; `issues?`: IssuesEvent \| undefined; `label?`: LabelEvent \| undefined; `merge_group?`: MergeGroupEvent \| undefined; `milestone?`: MilestoneEvent \| undefined; `page_build?`: PageBuildEvent \| undefined; `project?`: ProjectEvent \| undefined; `project_card?`: ProjectCardEvent \| undefined; `project_column?`: ProjectColumnEvent \| undefined; `public?`: PublicEvent \| undefined; `pull_request?`: `object` & `object` \| `null`; `pull_request_review?`: PullRequestReviewEvent \| undefined; `pull_request_review_comment?`: PullRequestReviewCommentEvent \| undefined; `pull_request_target?`: `object` & `object` \| `null`; `push?`: `object` & `object` \| `null`; `registry_package?`: RegistryPackageEvent \| undefined; `release?`: ReleaseEvent \| undefined; `repository_dispatch?`: RepositoryDispatchEvent \| undefined; `schedule?`: \[\{ `cron`: `string`; `timezone?`: `string`; \}, `...{ cron: string; timezone?: string }[]`\]; `status?`: StatusEvent \| undefined; `watch?`: WatchEvent \| undefined; `workflow_call?`: \{\[`k`: `string`\]: `unknown`; `inputs?`: \{\[`k`: `string`\]: `object`; \}; `outputs?`: \{\[`k`: `string`\]: `object`; \}; `secrets?`: \{\[`k`: `string`\]: `object`; \}; \}; `workflow_dispatch?`: \{ `inputs?`: \{\[`k`: `string`\]: [`WorkflowDispatchInput`](../type-aliases/WorkflowDispatchInput.md); \}; \}; `workflow_run?`: WorkflowRunEvent \| undefined; \} -Defined in: [types/githubActionsWorkflow.ts:527](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L527) +Defined in: [types/githubActionsWorkflow.ts:895](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L895) 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. -#### Type Declaration +#### Union Members [`Event`](../type-aliases/Event.md) +*** + \[[`Event`](../type-aliases/Event.md), `...Event[]`\] -\{ `branch_protection_rule?`: BranchProtectionRuleEvent \| undefined; `check_run?`: CheckRunEvent \| undefined; `check_suite?`: CheckSuiteEvent \| undefined; `create?`: CreateEvent \| undefined; `delete?`: DeleteEvent \| undefined; `deployment?`: DeploymentEvent \| undefined; `deployment_status?`: DeploymentStatusEvent \| undefined; `discussion?`: DiscussionEvent \| undefined; `discussion_comment?`: DiscussionCommentEvent \| undefined; `fork?`: ForkEvent \| undefined; `gollum?`: GollumEvent \| undefined; `issue_comment?`: IssueCommentEvent \| undefined; `issues?`: IssuesEvent \| undefined; `label?`: LabelEvent \| undefined; `merge_group?`: MergeGroupEvent \| undefined; `milestone?`: MilestoneEvent \| undefined; `page_build?`: PageBuildEvent \| undefined; `project?`: ProjectEvent \| undefined; `project_card?`: ProjectCardEvent \| undefined; `project_column?`: ProjectColumnEvent \| undefined; `public?`: PublicEvent \| undefined; `pull_request?`: `object` & `object` \| `null`; `pull_request_review?`: PullRequestReviewEvent \| undefined; `pull_request_review_comment?`: PullRequestReviewCommentEvent \| undefined; `pull_request_target?`: `object` & `object` \| `null`; `push?`: `object` & `object` \| `null`; `registry_package?`: RegistryPackageEvent \| undefined; `release?`: ReleaseEvent \| undefined; `repository_dispatch?`: RepositoryDispatchEvent \| undefined; `schedule?`: \[\{ `cron?`: `string`; \}, `...{ cron?: string }[]`\]; `status?`: StatusEvent \| undefined; `watch?`: WatchEvent \| undefined; `workflow_call?`: \{\[`k`: `string`\]: `unknown`; `inputs?`: \{\[`k`: `string`\]: `object`; \}; `outputs?`: \{\[`k`: `string`\]: `object`; \}; `secrets?`: \{\[`k`: `string`\]: `object`; \}; \}; `workflow_dispatch?`: \{ `inputs?`: \{\[`k`: `string`\]: [`WorkflowDispatchInput`](../type-aliases/WorkflowDispatchInput.md); \}; \}; `workflow_run?`: WorkflowRunEvent \| undefined; \} +*** + +##### Type Literal + +\{ `branch_protection_rule?`: BranchProtectionRuleEvent \| undefined; `check_run?`: CheckRunEvent \| undefined; `check_suite?`: CheckSuiteEvent \| undefined; `create?`: CreateEvent \| undefined; `delete?`: DeleteEvent \| undefined; `deployment?`: DeploymentEvent \| undefined; `deployment_status?`: DeploymentStatusEvent \| undefined; `discussion?`: DiscussionEvent \| undefined; `discussion_comment?`: DiscussionCommentEvent \| undefined; `fork?`: ForkEvent \| undefined; `gollum?`: GollumEvent \| undefined; `issue_comment?`: IssueCommentEvent \| undefined; `issues?`: IssuesEvent \| undefined; `label?`: LabelEvent \| undefined; `merge_group?`: MergeGroupEvent \| undefined; `milestone?`: MilestoneEvent \| undefined; `page_build?`: PageBuildEvent \| undefined; `project?`: ProjectEvent \| undefined; `project_card?`: ProjectCardEvent \| undefined; `project_column?`: ProjectColumnEvent \| undefined; `public?`: PublicEvent \| undefined; `pull_request?`: `object` & `object` \| `null`; `pull_request_review?`: PullRequestReviewEvent \| undefined; `pull_request_review_comment?`: PullRequestReviewCommentEvent \| undefined; `pull_request_target?`: `object` & `object` \| `null`; `push?`: `object` & `object` \| `null`; `registry_package?`: RegistryPackageEvent \| undefined; `release?`: ReleaseEvent \| undefined; `repository_dispatch?`: RepositoryDispatchEvent \| undefined; `schedule?`: \[\{ `cron`: `string`; `timezone?`: `string`; \}, `...{ cron: string; timezone?: string }[]`\]; `status?`: StatusEvent \| undefined; `watch?`: WatchEvent \| undefined; `workflow_call?`: \{\[`k`: `string`\]: `unknown`; `inputs?`: \{\[`k`: `string`\]: `object`; \}; `outputs?`: \{\[`k`: `string`\]: `object`; \}; `secrets?`: \{\[`k`: `string`\]: `object`; \}; \}; `workflow_dispatch?`: \{ `inputs?`: \{\[`k`: `string`\]: [`WorkflowDispatchInput`](../type-aliases/WorkflowDispatchInput.md); \}; \}; `workflow_run?`: WorkflowRunEvent \| undefined; \} -#### branch\_protection\_rule? +##### branch\_protection\_rule? -> `optional` **branch\_protection\_rule**: BranchProtectionRuleEvent \| undefined +> `optional` **branch\_protection\_rule?**: BranchProtectionRuleEvent \| undefined -#### check\_run? +##### check\_run? -> `optional` **check\_run**: CheckRunEvent \| undefined +> `optional` **check\_run?**: CheckRunEvent \| undefined -#### check\_suite? +##### check\_suite? -> `optional` **check\_suite**: CheckSuiteEvent \| undefined +> `optional` **check\_suite?**: CheckSuiteEvent \| undefined -#### create? +##### create? -> `optional` **create**: CreateEvent \| undefined +> `optional` **create?**: CreateEvent \| undefined -#### delete? +##### delete? -> `optional` **delete**: DeleteEvent \| undefined +> `optional` **delete?**: DeleteEvent \| undefined -#### deployment? +##### deployment? -> `optional` **deployment**: DeploymentEvent \| undefined +> `optional` **deployment?**: DeploymentEvent \| undefined -#### deployment\_status? +##### deployment\_status? -> `optional` **deployment\_status**: DeploymentStatusEvent \| undefined +> `optional` **deployment\_status?**: DeploymentStatusEvent \| undefined -#### discussion? +##### discussion? -> `optional` **discussion**: DiscussionEvent \| undefined +> `optional` **discussion?**: DiscussionEvent \| undefined -#### discussion\_comment? +##### discussion\_comment? -> `optional` **discussion\_comment**: DiscussionCommentEvent \| undefined +> `optional` **discussion\_comment?**: DiscussionCommentEvent \| undefined -#### fork? +##### fork? -> `optional` **fork**: ForkEvent \| undefined +> `optional` **fork?**: ForkEvent \| undefined -#### gollum? +##### gollum? -> `optional` **gollum**: GollumEvent \| undefined +> `optional` **gollum?**: GollumEvent \| undefined -#### issue\_comment? +##### issue\_comment? -> `optional` **issue\_comment**: IssueCommentEvent \| undefined +> `optional` **issue\_comment?**: IssueCommentEvent \| undefined -#### issues? +##### issues? -> `optional` **issues**: IssuesEvent \| undefined +> `optional` **issues?**: IssuesEvent \| undefined -#### label? +##### label? -> `optional` **label**: LabelEvent \| undefined +> `optional` **label?**: LabelEvent \| undefined -#### merge\_group? +##### merge\_group? -> `optional` **merge\_group**: MergeGroupEvent \| undefined +> `optional` **merge\_group?**: MergeGroupEvent \| undefined -#### milestone? +##### milestone? -> `optional` **milestone**: MilestoneEvent \| undefined +> `optional` **milestone?**: MilestoneEvent \| undefined -#### page\_build? +##### page\_build? -> `optional` **page\_build**: PageBuildEvent \| undefined +> `optional` **page\_build?**: PageBuildEvent \| undefined -#### project? +##### project? -> `optional` **project**: ProjectEvent \| undefined +> `optional` **project?**: ProjectEvent \| undefined -#### project\_card? +##### project\_card? -> `optional` **project\_card**: ProjectCardEvent \| undefined +> `optional` **project\_card?**: ProjectCardEvent \| undefined -#### project\_column? +##### project\_column? -> `optional` **project\_column**: ProjectColumnEvent \| undefined +> `optional` **project\_column?**: ProjectColumnEvent \| undefined -#### public? +##### public? -> `optional` **public**: PublicEvent \| undefined +> `optional` **public?**: PublicEvent \| undefined -#### pull\_request? +##### pull\_request? -> `optional` **pull\_request**: `object` & `object` \| `null` +> `optional` **pull\_request?**: `object` & `object` \| `null` 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. Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. @@ -179,68 +185,68 @@ When you create a pull request from a forked repository to the base repository, Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. 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. -#### pull\_request\_review? +##### pull\_request\_review? -> `optional` **pull\_request\_review**: PullRequestReviewEvent \| undefined +> `optional` **pull\_request\_review?**: PullRequestReviewEvent \| undefined -#### pull\_request\_review\_comment? +##### pull\_request\_review\_comment? -> `optional` **pull\_request\_review\_comment**: PullRequestReviewCommentEvent \| undefined +> `optional` **pull\_request\_review\_comment?**: PullRequestReviewCommentEvent \| undefined -#### pull\_request\_target? +##### pull\_request\_target? -> `optional` **pull\_request\_target**: `object` & `object` \| `null` +> `optional` **pull\_request\_target?**: `object` & `object` \| `null` 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. -#### push? +##### push? -> `optional` **push**: `object` & `object` \| `null` +> `optional` **push?**: `object` & `object` \| `null` Runs your workflow when someone pushes to a repository branch, which triggers the push event. Note: The webhook payload available to GitHub Actions does not include the added, removed, and modified attributes in the commit object. You can retrieve the full commit object using the REST API. For more information, see https://developer.github.com/v3/repos/commits/#get-a-single-commit. -#### registry\_package? +##### registry\_package? -> `optional` **registry\_package**: RegistryPackageEvent \| undefined +> `optional` **registry\_package?**: RegistryPackageEvent \| undefined -#### release? +##### release? -> `optional` **release**: ReleaseEvent \| undefined +> `optional` **release?**: ReleaseEvent \| undefined -#### repository\_dispatch? +##### repository\_dispatch? -> `optional` **repository\_dispatch**: RepositoryDispatchEvent \| undefined +> `optional` **repository\_dispatch?**: RepositoryDispatchEvent \| undefined -#### schedule? +##### schedule? -> `optional` **schedule**: \[\{ `cron?`: `string`; \}, `...{ cron?: string }[]`\] +> `optional` **schedule?**: \[\{ `cron`: `string`; `timezone?`: `string`; \}, `...{ cron: string; timezone?: string }[]`\] -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. +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). You can optionally specify a timezone using an IANA timezone string (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for timezone-aware scheduling. 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. Note: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot. -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). +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). -#### status? +##### status? -> `optional` **status**: StatusEvent \| undefined +> `optional` **status?**: StatusEvent \| undefined -#### watch? +##### watch? -> `optional` **watch**: WatchEvent \| undefined +> `optional` **watch?**: WatchEvent \| undefined -#### workflow\_call? +##### workflow\_call? -> `optional` **workflow\_call**: `object` +> `optional` **workflow\_call?**: `object` Allows workflows to be reused by other workflows. -##### Index Signature +###### Index Signature \[`k`: `string`\]: `unknown` -##### workflow\_call.inputs? +###### workflow\_call.inputs? -> `optional` **inputs**: `object` +> `optional` **inputs?**: `object` When using the workflow_call keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow. @@ -253,9 +259,9 @@ A string identifier to associate with the input. The value of \ is a This interface was referenced by `undefined`'s JSON-Schema definition via the `patternProperty` "^[_a-zA-Z][a-zA-Z0-9_-]*$". -##### workflow\_call.outputs? +###### workflow\_call.outputs? -> `optional` **outputs**: `object` +> `optional` **outputs?**: `object` When using the workflow_call keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow. @@ -268,9 +274,9 @@ A string identifier to associate with the output. The value of \ is This interface was referenced by `undefined`'s JSON-Schema definition via the `patternProperty` "^[_a-zA-Z][a-zA-Z0-9_-]*$". -##### workflow\_call.secrets? +###### workflow\_call.secrets? -> `optional` **secrets**: `object` +> `optional` **secrets?**: `object` A map of the secrets that can be used in the called workflow. Within the called workflow, you can use the secrets context to refer to a secret. @@ -283,15 +289,15 @@ A string identifier to associate with the secret. This interface was referenced by `undefined`'s JSON-Schema definition via the `patternProperty` "^[_a-zA-Z][a-zA-Z0-9_-]*$". -#### workflow\_dispatch? +##### workflow\_dispatch? -> `optional` **workflow\_dispatch**: `object` +> `optional` **workflow\_dispatch?**: `object` You can now create workflows that are manually triggered with the new workflow_dispatch event. You will then see a 'Run workflow' button on the Actions tab, enabling you to easily trigger a run. -##### workflow\_dispatch.inputs? +###### workflow\_dispatch.inputs? -> `optional` **inputs**: `object` +> `optional` **inputs?**: `object` Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids. @@ -299,24 +305,24 @@ Input parameters allow you to specify data that the action expects to use during \[`k`: `string`\]: [`WorkflowDispatchInput`](../type-aliases/WorkflowDispatchInput.md) -#### workflow\_run? +##### workflow\_run? -> `optional` **workflow\_run**: WorkflowRunEvent \| undefined +> `optional` **workflow\_run?**: WorkflowRunEvent \| undefined *** ### permissions? -> `optional` **permissions**: [`Permissions`](../type-aliases/Permissions.md) +> `optional` **permissions?**: [`Permissions`](../type-aliases/Permissions.md) -Defined in: [types/githubActionsWorkflow.ts:746](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L746) +Defined in: [types/githubActionsWorkflow.ts:1128](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1128) *** ### run-name? -> `optional` **run-name**: `string` +> `optional` **run-name?**: `string` -Defined in: [types/githubActionsWorkflow.ts:745](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L745) +Defined in: [types/githubActionsWorkflow.ts:1127](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L1127) The name for workflow runs generated from the workflow. GitHub displays the workflow run name in the list of workflow runs on your repository's 'Actions' tab. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Branch.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Branch.md index a4658ac..cd60d00 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Branch.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Branch.md @@ -8,7 +8,7 @@ > **Branch** = \[`string`, `...string[]`\] -Defined in: [types/githubActionsWorkflow.ts:211](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L211) +Defined in: [types/githubActionsWorkflow.ts:336](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L336) 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. 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/BranchProtectionRuleEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/BranchProtectionRuleEvent.md index a3dd9d0..6859f95 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/BranchProtectionRuleEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/BranchProtectionRuleEvent.md @@ -6,8 +6,8 @@ # Type Alias: BranchProtectionRuleEvent -> **BranchProtectionRuleEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **BranchProtectionRuleEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`BranchProtectionRuleEventTypes`](BranchProtectionRuleEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:48](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L48) +Defined in: [types/githubActionsWorkflow.ts:48](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L48) Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/BranchProtectionRuleEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/BranchProtectionRuleEventTypes.md new file mode 100644 index 0000000..f61a218 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/BranchProtectionRuleEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / BranchProtectionRuleEventTypes + +# Type Alias: BranchProtectionRuleEventTypes + +> **BranchProtectionRuleEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"edited"` \| `"deleted"`)[] + +Defined in: [types/githubActionsWorkflow.ts:56](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L56) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckRunEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckRunEvent.md index fe4717c..2efcde6 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckRunEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckRunEvent.md @@ -6,8 +6,8 @@ # Type Alias: CheckRunEvent -> **CheckRunEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **CheckRunEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`CheckRunEventTypes`](CheckRunEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:54](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L54) +Defined in: [types/githubActionsWorkflow.ts:64](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L64) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckRunEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckRunEventTypes.md new file mode 100644 index 0000000..437a02e --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckRunEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / CheckRunEventTypes + +# Type Alias: CheckRunEventTypes + +> **CheckRunEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"rerequested"` \| `"completed"` \| `"requested_action"`)[] + +Defined in: [types/githubActionsWorkflow.ts:72](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L72) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckSuiteEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckSuiteEvent.md index d033159..ed1b284 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckSuiteEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckSuiteEvent.md @@ -6,8 +6,8 @@ # Type Alias: CheckSuiteEvent -> **CheckSuiteEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **CheckSuiteEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`CheckSuiteEventTypes`](CheckSuiteEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:60](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L60) +Defined in: [types/githubActionsWorkflow.ts:77](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L77) 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/. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckSuiteEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckSuiteEventTypes.md new file mode 100644 index 0000000..54d8b12 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CheckSuiteEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / CheckSuiteEventTypes + +# Type Alias: CheckSuiteEventTypes + +> **CheckSuiteEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"completed"` \| `"requested"` \| `"rerequested"`)[] + +Defined in: [types/githubActionsWorkflow.ts:85](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L85) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Configuration.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Configuration.md index 51aa2e3..8a8ccf4 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Configuration.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Configuration.md @@ -8,4 +8,4 @@ > **Configuration** = `string` \| `number` \| `boolean` \| \{\[`k`: `string`\]: `Configuration`; \} \| `Configuration`[] -Defined in: [types/githubActionsWorkflow.ts:502](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L502) +Defined in: [types/githubActionsWorkflow.ts:870](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L870) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CreateEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CreateEvent.md index 4597399..83be687 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CreateEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/CreateEvent.md @@ -8,6 +8,6 @@ > **CreateEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:66](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L66) +Defined in: [types/githubActionsWorkflow.ts:90](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L90) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeleteEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeleteEvent.md index e5248b4..7450fe6 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeleteEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeleteEvent.md @@ -8,6 +8,6 @@ > **DeleteEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:72](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L72) +Defined in: [types/githubActionsWorkflow.ts:96](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L96) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeploymentEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeploymentEvent.md index 825a38f..3218a4a 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeploymentEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeploymentEvent.md @@ -8,6 +8,6 @@ > **DeploymentEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:78](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L78) +Defined in: [types/githubActionsWorkflow.ts:102](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L102) 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/. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeploymentStatusEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeploymentStatusEvent.md index a2e2b2e..1a8c894 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeploymentStatusEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DeploymentStatusEvent.md @@ -8,6 +8,6 @@ > **DeploymentStatusEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:84](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L84) +Defined in: [types/githubActionsWorkflow.ts:108](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L108) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionCommentEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionCommentEvent.md index 20cf25f..593952a 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionCommentEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionCommentEvent.md @@ -6,8 +6,8 @@ # Type Alias: DiscussionCommentEvent -> **DiscussionCommentEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **DiscussionCommentEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`DiscussionCommentEventTypes`](DiscussionCommentEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:96](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L96) +Defined in: [types/githubActionsWorkflow.ts:141](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L141) 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 diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionCommentEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionCommentEventTypes.md new file mode 100644 index 0000000..446d597 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionCommentEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / DiscussionCommentEventTypes + +# Type Alias: DiscussionCommentEventTypes + +> **DiscussionCommentEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"edited"` \| `"deleted"`)[] + +Defined in: [types/githubActionsWorkflow.ts:149](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L149) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionEvent.md index d9d4850..7f2975a 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionEvent.md @@ -6,8 +6,8 @@ # Type Alias: DiscussionEvent -> **DiscussionEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **DiscussionEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`DiscussionEventTypes`](DiscussionEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:90](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L90) +Defined in: [types/githubActionsWorkflow.ts:114](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L114) 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 diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionEventTypes.md new file mode 100644 index 0000000..f107813 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/DiscussionEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / DiscussionEventTypes + +# Type Alias: DiscussionEventTypes + +> **DiscussionEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"edited"` \| `"deleted"` \| `"transferred"` \| `"pinned"` \| `"unpinned"` \| `"labeled"` \| `"unlabeled"` \| `"locked"` \| `"unlocked"` \| `"category_changed"` \| `"answered"` \| `"unanswered"`)[] + +Defined in: [types/githubActionsWorkflow.ts:122](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L122) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Env.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Env.md index f19c943..a19088e 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Env.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Env.md @@ -8,7 +8,7 @@ > **Env** = `object` & \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} \| [`StringContainingExpressionSyntax`](StringContainingExpressionSyntax.md) -Defined in: [types/githubActionsWorkflow.ts:475](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L475) +Defined in: [types/githubActionsWorkflow.ts:831](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L831) A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case. @@ -16,8 +16,8 @@ A map of the input parameters defined by the action. Each input parameter is a k ### args? -> `optional` **args**: `string` +> `optional` **args?**: `string` ### entrypoint? -> `optional` **entrypoint**: `string` +> `optional` **entrypoint?**: `string` diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Env1.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Env1.md index c759e36..0915a99 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Env1.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Env1.md @@ -8,6 +8,6 @@ > **Env1** = \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} \| [`StringContainingExpressionSyntax`](StringContainingExpressionSyntax.md) -Defined in: [types/githubActionsWorkflow.ts:513](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L513) +Defined in: [types/githubActionsWorkflow.ts:881](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L881) To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.\.steps[*].env, jobs.\.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Event.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Event.md index 3b79202..18f1e81 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Event.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Event.md @@ -8,7 +8,7 @@ > **Event** = `"branch_protection_rule"` \| `"check_run"` \| `"check_suite"` \| `"create"` \| `"delete"` \| `"deployment"` \| `"deployment_status"` \| `"discussion"` \| `"discussion_comment"` \| `"fork"` \| `"gollum"` \| `"issue_comment"` \| `"issues"` \| `"label"` \| `"merge_group"` \| `"milestone"` \| `"page_build"` \| `"project"` \| `"project_card"` \| `"project_column"` \| `"public"` \| `"pull_request"` \| `"pull_request_review"` \| `"pull_request_review_comment"` \| `"pull_request_target"` \| `"push"` \| `"registry_package"` \| `"release"` \| `"status"` \| `"watch"` \| `"workflow_call"` \| `"workflow_dispatch"` \| `"workflow_run"` \| `"repository_dispatch"` -Defined in: [types/githubActionsWorkflow.ts:10](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L10) +Defined in: [types/githubActionsWorkflow.ts:10](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L10) This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ExpressionSyntax.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ExpressionSyntax.md index 5a0bed6..6751c1d 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ExpressionSyntax.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ExpressionSyntax.md @@ -8,4 +8,4 @@ > **ExpressionSyntax** = `string` -Defined in: [types/githubActionsWorkflow.ts:350](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L350) +Defined in: [types/githubActionsWorkflow.ts:524](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L524) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ForkEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ForkEvent.md index 82a8369..be537d6 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ForkEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ForkEvent.md @@ -8,6 +8,6 @@ > **ForkEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:102](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L102) +Defined in: [types/githubActionsWorkflow.ts:154](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L154) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/GollumEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/GollumEvent.md index d623759..fea7fdd 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/GollumEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/GollumEvent.md @@ -8,6 +8,6 @@ > **GollumEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:108](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L108) +Defined in: [types/githubActionsWorkflow.ts:160](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L160) Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssueCommentEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssueCommentEvent.md index 3be14f8..c907d8b 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssueCommentEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssueCommentEvent.md @@ -6,8 +6,8 @@ # Type Alias: IssueCommentEvent -> **IssueCommentEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **IssueCommentEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`IssueCommentEventTypes`](IssueCommentEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:114](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L114) +Defined in: [types/githubActionsWorkflow.ts:166](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L166) 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/. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssueCommentEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssueCommentEventTypes.md new file mode 100644 index 0000000..6bf422f --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssueCommentEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / IssueCommentEventTypes + +# Type Alias: IssueCommentEventTypes + +> **IssueCommentEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"edited"` \| `"deleted"`)[] + +Defined in: [types/githubActionsWorkflow.ts:174](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L174) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssuesEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssuesEvent.md index b89d655..2dcd80c 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssuesEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssuesEvent.md @@ -6,8 +6,8 @@ # Type Alias: IssuesEvent -> **IssuesEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **IssuesEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`IssuesEventTypes`](IssuesEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:120](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L120) +Defined in: [types/githubActionsWorkflow.ts:179](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L179) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssuesEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssuesEventTypes.md new file mode 100644 index 0000000..49f6ed1 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/IssuesEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / IssuesEventTypes + +# Type Alias: IssuesEventTypes + +> **IssuesEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"opened"` \| `"edited"` \| `"deleted"` \| `"transferred"` \| `"pinned"` \| `"unpinned"` \| `"closed"` \| `"reopened"` \| `"assigned"` \| `"unassigned"` \| `"labeled"` \| `"unlabeled"` \| `"locked"` \| `"unlocked"` \| `"milestoned"` \| `"demilestoned"`)[] + +Defined in: [types/githubActionsWorkflow.ts:187](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L187) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/JobNeeds.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/JobNeeds.md index 925ed5e..10b0274 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/JobNeeds.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/JobNeeds.md @@ -8,6 +8,6 @@ > **JobNeeds** = \[[`Name`](Name.md), `...Name[]`\] \| [`Name`](Name.md) -Defined in: [types/githubActionsWorkflow.ts:354](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L354) +Defined in: [types/githubActionsWorkflow.ts:528](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L528) Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/LabelEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/LabelEvent.md index dfd99d9..eead73f 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/LabelEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/LabelEvent.md @@ -6,8 +6,8 @@ # Type Alias: LabelEvent -> **LabelEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **LabelEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`LabelEventTypes`](LabelEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:126](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L126) +Defined in: [types/githubActionsWorkflow.ts:209](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L209) 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/. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/LabelEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/LabelEventTypes.md new file mode 100644 index 0000000..c3697d6 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/LabelEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / LabelEventTypes + +# Type Alias: LabelEventTypes + +> **LabelEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"edited"` \| `"deleted"`)[] + +Defined in: [types/githubActionsWorkflow.ts:217](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L217) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Matrix.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Matrix.md index cc288d6..5f40ed6 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Matrix.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Matrix.md @@ -8,7 +8,7 @@ > **Matrix** = \{\[`k`: `string`\]: `string` \| \[[`Configuration`](Configuration.md), `...Configuration[]`\]; \} \| [`ExpressionSyntax`](ExpressionSyntax.md) -Defined in: [types/githubActionsWorkflow.ts:497](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L497) +Defined in: [types/githubActionsWorkflow.ts:865](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L865) A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status. You can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MergeGroupEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MergeGroupEvent.md index 9d8c653..2992c93 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MergeGroupEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MergeGroupEvent.md @@ -6,8 +6,8 @@ # Type Alias: MergeGroupEvent -> **MergeGroupEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **MergeGroupEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`MergeGroupEventTypes`](MergeGroupEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:132](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L132) +Defined in: [types/githubActionsWorkflow.ts:222](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L222) 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 . diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MergeGroupEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MergeGroupEventTypes.md new file mode 100644 index 0000000..a9b2841 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MergeGroupEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / MergeGroupEventTypes + +# Type Alias: MergeGroupEventTypes + +> **MergeGroupEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & `"checks_requested"`[] + +Defined in: [types/githubActionsWorkflow.ts:230](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L230) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MilestoneEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MilestoneEvent.md index d2f3f96..fb9132c 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MilestoneEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MilestoneEvent.md @@ -6,8 +6,8 @@ # Type Alias: MilestoneEvent -> **MilestoneEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **MilestoneEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`MilestoneEventTypes`](MilestoneEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:138](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L138) +Defined in: [types/githubActionsWorkflow.ts:235](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L235) 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/. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MilestoneEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MilestoneEventTypes.md new file mode 100644 index 0000000..7b60a24 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/MilestoneEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / MilestoneEventTypes + +# Type Alias: MilestoneEventTypes + +> **MilestoneEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"closed"` \| `"opened"` \| `"edited"` \| `"deleted"`)[] + +Defined in: [types/githubActionsWorkflow.ts:243](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L243) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Name.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Name.md index 74f20f3..eb74e89 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Name.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Name.md @@ -8,4 +8,4 @@ > **Name** = `string` -Defined in: [types/githubActionsWorkflow.ts:355](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L355) +Defined in: [types/githubActionsWorkflow.ts:529](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L529) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PageBuildEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PageBuildEvent.md index cd93f2f..8d9197e 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PageBuildEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PageBuildEvent.md @@ -8,6 +8,6 @@ > **PageBuildEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:144](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L144) +Defined in: [types/githubActionsWorkflow.ts:248](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L248) 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/. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Path.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Path.md index 71390fa..6c73e94 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Path.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Path.md @@ -8,7 +8,7 @@ > **Path** = \[`string`, `...string[]`\] -Defined in: [types/githubActionsWorkflow.ts:220](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L220) +Defined in: [types/githubActionsWorkflow.ts:345](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L345) When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. Path filters are not evaluated for pushes to tags. The paths-ignore and paths keywords accept glob patterns that use the * and ** wildcard characters to match more than one path 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Permissions.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Permissions.md index e49d44e..fc7dfc7 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Permissions.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Permissions.md @@ -8,6 +8,6 @@ > **Permissions** = `"read-all"` \| `"write-all"` \| [`PermissionsEvent`](../interfaces/PermissionsEvent.md) -Defined in: [types/githubActionsWorkflow.ts:371](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L371) +Defined in: [types/githubActionsWorkflow.ts:545](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L545) You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PermissionsLevel.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PermissionsLevel.md index afd90c2..dd58e65 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PermissionsLevel.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PermissionsLevel.md @@ -8,4 +8,4 @@ > **PermissionsLevel** = `"read"` \| `"write"` \| `"none"` -Defined in: [types/githubActionsWorkflow.ts:372](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L372) +Defined in: [types/githubActionsWorkflow.ts:546](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L546) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectCardEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectCardEvent.md index 8186903..285504d 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectCardEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectCardEvent.md @@ -6,8 +6,8 @@ # Type Alias: ProjectCardEvent -> **ProjectCardEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **ProjectCardEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`ProjectCardEventTypes`](ProjectCardEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:156](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L156) +Defined in: [types/githubActionsWorkflow.ts:267](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L267) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectCardEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectCardEventTypes.md new file mode 100644 index 0000000..90fcab6 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectCardEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / ProjectCardEventTypes + +# Type Alias: ProjectCardEventTypes + +> **ProjectCardEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"moved"` \| `"converted"` \| `"edited"` \| `"deleted"`)[] + +Defined in: [types/githubActionsWorkflow.ts:275](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L275) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectColumnEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectColumnEvent.md index 780f0e6..9fd8d1f 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectColumnEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectColumnEvent.md @@ -6,8 +6,8 @@ # Type Alias: ProjectColumnEvent -> **ProjectColumnEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **ProjectColumnEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`ProjectColumnEventTypes`](ProjectColumnEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:162](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L162) +Defined in: [types/githubActionsWorkflow.ts:280](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L280) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectColumnEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectColumnEventTypes.md new file mode 100644 index 0000000..1e2c6ee --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectColumnEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / ProjectColumnEventTypes + +# Type Alias: ProjectColumnEventTypes + +> **ProjectColumnEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"updated"` \| `"moved"` \| `"deleted"`)[] + +Defined in: [types/githubActionsWorkflow.ts:288](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L288) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectEvent.md index dc81992..f60a547 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectEvent.md @@ -6,8 +6,8 @@ # Type Alias: ProjectEvent -> **ProjectEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **ProjectEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`ProjectEventTypes`](ProjectEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:150](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L150) +Defined in: [types/githubActionsWorkflow.ts:254](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L254) 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/. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectEventTypes.md new file mode 100644 index 0000000..c538c97 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ProjectEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / ProjectEventTypes + +# Type Alias: ProjectEventTypes + +> **ProjectEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"updated"` \| `"closed"` \| `"reopened"` \| `"edited"` \| `"deleted"`)[] + +Defined in: [types/githubActionsWorkflow.ts:262](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L262) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PublicEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PublicEvent.md index 00acd5b..ebc170c 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PublicEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PublicEvent.md @@ -8,6 +8,6 @@ > **PublicEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:168](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L168) +Defined in: [types/githubActionsWorkflow.ts:293](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L293) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestEventTypes.md index 040a316..5cde98e 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestEventTypes.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestEventTypes.md @@ -8,7 +8,7 @@ > **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"`)[] -Defined in: [types/githubActionsWorkflow.ts:175](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L175) +Defined in: [types/githubActionsWorkflow.ts:300](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L300) 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. 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewCommentEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewCommentEvent.md index a661501..8054529 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewCommentEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewCommentEvent.md @@ -6,9 +6,9 @@ # Type Alias: PullRequestReviewCommentEvent -> **PullRequestReviewCommentEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **PullRequestReviewCommentEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`PullRequestReviewCommentEventTypes`](PullRequestReviewCommentEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:238](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L238) +Defined in: [types/githubActionsWorkflow.ts:370](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L370) 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. Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewCommentEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewCommentEventTypes.md new file mode 100644 index 0000000..a2ead93 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewCommentEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / PullRequestReviewCommentEventTypes + +# Type Alias: PullRequestReviewCommentEventTypes + +> **PullRequestReviewCommentEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"created"` \| `"edited"` \| `"deleted"`)[] + +Defined in: [types/githubActionsWorkflow.ts:378](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L378) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewEvent.md index f8e2b0e..ebcdcff 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewEvent.md @@ -6,9 +6,9 @@ # Type Alias: PullRequestReviewEvent -> **PullRequestReviewEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **PullRequestReviewEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`PullRequestReviewEventTypes`](PullRequestReviewEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:228](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L228) +Defined in: [types/githubActionsWorkflow.ts:353](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L353) Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews. Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewEventTypes.md new file mode 100644 index 0000000..d294bcb --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestReviewEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / PullRequestReviewEventTypes + +# Type Alias: PullRequestReviewEventTypes + +> **PullRequestReviewEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"submitted"` \| `"edited"` \| `"dismissed"`)[] + +Defined in: [types/githubActionsWorkflow.ts:361](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L361) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestTargetEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestTargetEventTypes.md index 9504770..6ebf1fa 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestTargetEventTypes.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/PullRequestTargetEventTypes.md @@ -8,7 +8,7 @@ > **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"`)[] -Defined in: [types/githubActionsWorkflow.ts:245](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L245) +Defined in: [types/githubActionsWorkflow.ts:387](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L387) 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. 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RegistryPackageEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RegistryPackageEvent.md index 76f0502..9fab8b4 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RegistryPackageEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RegistryPackageEvent.md @@ -6,8 +6,8 @@ # Type Alias: RegistryPackageEvent -> **RegistryPackageEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **RegistryPackageEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`RegistryPackageEventTypes`](RegistryPackageEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:268](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L268) +Defined in: [types/githubActionsWorkflow.ts:410](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L410) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RegistryPackageEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RegistryPackageEventTypes.md new file mode 100644 index 0000000..734fb4b --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RegistryPackageEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / RegistryPackageEventTypes + +# Type Alias: RegistryPackageEventTypes + +> **RegistryPackageEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"published"` \| `"updated"`)[] + +Defined in: [types/githubActionsWorkflow.ts:418](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L418) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ReleaseEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ReleaseEvent.md index a01033d..a58acc7 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ReleaseEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ReleaseEvent.md @@ -6,8 +6,8 @@ # Type Alias: ReleaseEvent -> **ReleaseEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **ReleaseEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`ReleaseEventTypes`](ReleaseEventTypes.md); \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:274](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L274) +Defined in: [types/githubActionsWorkflow.ts:423](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L423) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ReleaseEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ReleaseEventTypes.md new file mode 100644 index 0000000..70cb051 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/ReleaseEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / ReleaseEventTypes + +# Type Alias: ReleaseEventTypes + +> **ReleaseEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"published"` \| `"unpublished"` \| `"created"` \| `"edited"` \| `"deleted"` \| `"prereleased"` \| `"released"`)[] + +Defined in: [types/githubActionsWorkflow.ts:431](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L431) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RepositoryDispatchEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RepositoryDispatchEvent.md index de683f1..3220ab3 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RepositoryDispatchEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/RepositoryDispatchEvent.md @@ -8,7 +8,7 @@ > **RepositoryDispatchEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:336](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L336) +Defined in: [types/githubActionsWorkflow.ts:510](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L510) 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. 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Shell.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Shell.md index b44b4a6..ba750be 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Shell.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Shell.md @@ -8,6 +8,6 @@ > **Shell** = `string` \| `"bash"` \| `"pwsh"` \| `"python"` \| `"sh"` \| `"cmd"` \| `"powershell"` -Defined in: [types/githubActionsWorkflow.ts:343](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L343) +Defined in: [types/githubActionsWorkflow.ts:517](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L517) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Snapshot.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Snapshot.md index b182c33..aaeffde 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Snapshot.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Snapshot.md @@ -8,9 +8,9 @@ > **Snapshot** = `string` \| \{ `image-name`: `string`; `version?`: `string`; \} -Defined in: [types/githubActionsWorkflow.ts:362](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L362) +Defined in: [types/githubActionsWorkflow.ts:536](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L536) -You can use `jobs..snapshot` to generate a custom image. +You can use `jobs.<job_id>.snapshot` to generate a custom image. Add the snapshot keyword to the job, using either the string syntax or mapping syntax as shown in https://docs.github.com/en/actions/how-tos/manage-runners/larger-runners/use-custom-images#generating-a-custom-image. Each job that includes the snapshot keyword creates a separate image. To generate only one image or image version, include all workflow steps in a single job. Each successful run of a job that includes the snapshot keyword creates a new version of that image. For more information, see https://docs.github.com/en/actions/how-tos/manage-runners/larger-runners/use-custom-images. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/StatusEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/StatusEvent.md index e71fce5..940f475 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/StatusEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/StatusEvent.md @@ -8,6 +8,6 @@ > **StatusEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:280](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L280) +Defined in: [types/githubActionsWorkflow.ts:444](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L444) 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/. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Step.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Step.md index 2cec053..6ad9a52 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Step.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Step.md @@ -6,46 +6,266 @@ # Type Alias: Step -> **Step** = `object` & [`Step1`](Step1.md) & `object` & [`Step1`](Step1.md) +> **Step** = `object` & [`Step1`](Step1.md) & `object` & [`Step1`](Step1.md) & `object` & [`Step1`](Step1.md) & `object` & [`Step1`](Step1.md) -Defined in: [types/githubActionsWorkflow.ts:373](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L373) +Defined in: [types/githubActionsWorkflow.ts:547](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L547) ## Type Declaration +### background? + +> `optional` **background?**: `boolean` + +Runs a step asynchronously so the job continues to the next step without waiting for it to finish. You can use background on steps that use run or uses. To reference a background step from wait or cancel, give it an id. A maximum of 10 background steps can run concurrently in a single job. + +### cancel? + +> `optional` **cancel?**: `string` + +Gracefully terminates a running background step. The runner sends the step's process a termination signal (SIGTERM) so it can clean up. The cancel keyword targets a single background step by its id. + +### continue-on-error? + +> `optional` **continue-on-error?**: `boolean` \| [`ExpressionSyntax`](ExpressionSyntax.md) + +Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails. + +### env? + +> `optional` **env?**: \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} \| [`StringContainingExpressionSyntax`](StringContainingExpressionSyntax.md) + +Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job. + +### id? + +> `optional` **id?**: `string` + +A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. + +### if? + +> `optional` **if?**: `boolean` \| `number` \| `string` + +You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional. +Expressions in an if conditional do not require the $\{\{ \}\} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. + +### name? + +> `optional` **name?**: `string` + +A name for your step to display on GitHub. + +### parallel? + +> `optional` **parallel?**: \[`Step`, `...Step[]`\] + +Runs a group of steps concurrently, then waits for all of them to finish before continuing. Every step in the group runs as a background step, with an implicit wait at the end of the group. + +### run? + +> `optional` **run?**: `string` + +Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command. +Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell. +Each run keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell. + +### shell? + +> `optional` **shell?**: [`Shell`](Shell.md) + +### timeout-minutes? + +> `optional` **timeout-minutes?**: `number` \| [`ExpressionSyntax`](ExpressionSyntax.md) + +The maximum number of minutes to run the step before killing the process. + +### uses? + +> `optional` **uses?**: `string` + +Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/). +We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. +- Using the commit SHA of a released action version is the safest for stability and security. +- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. +- Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break. +Some actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required. +Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions. + +### wait? + +> `optional` **wait?**: `string` \| \[`string`, `...string[]`\] + +Pauses the job until one or more background steps complete. Provide a single step id as a string, or multiple step ids as an array. After a wait step completes, the outputs of the referenced background steps become available to subsequent steps. + +### wait-all? + +> `optional` **wait-all?**: `boolean` \| `null` + +Pauses the job until all active background steps complete. The wait-all keyword takes no arguments. + +### with? + +> `optional` **with?**: [`Env`](Env.md) + +### working-directory? + +> `optional` **working-directory?**: [`WorkingDirectory`](WorkingDirectory.md) + +## Type Declaration + +### background? + +> `optional` **background?**: `boolean` + +Runs a step asynchronously so the job continues to the next step without waiting for it to finish. You can use background on steps that use run or uses. To reference a background step from wait or cancel, give it an id. A maximum of 10 background steps can run concurrently in a single job. + +### cancel? + +> `optional` **cancel?**: `string` + +Gracefully terminates a running background step. The runner sends the step's process a termination signal (SIGTERM) so it can clean up. The cancel keyword targets a single background step by its id. + +### continue-on-error? + +> `optional` **continue-on-error?**: `boolean` \| [`ExpressionSyntax`](ExpressionSyntax.md) + +Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails. + +### env? + +> `optional` **env?**: \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} \| [`StringContainingExpressionSyntax`](StringContainingExpressionSyntax.md) + +Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job. + +### id? + +> `optional` **id?**: `string` + +A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. + +### if? + +> `optional` **if?**: `boolean` \| `number` \| `string` + +You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional. +Expressions in an if conditional do not require the $\{\{ \}\} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. + +### name? + +> `optional` **name?**: `string` + +A name for your step to display on GitHub. + +### parallel? + +> `optional` **parallel?**: \[`Step`, `...Step[]`\] + +Runs a group of steps concurrently, then waits for all of them to finish before continuing. Every step in the group runs as a background step, with an implicit wait at the end of the group. + +### run? + +> `optional` **run?**: `string` + +Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command. +Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell. +Each run keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell. + +### shell? + +> `optional` **shell?**: [`Shell`](Shell.md) + +### timeout-minutes? + +> `optional` **timeout-minutes?**: `number` \| [`ExpressionSyntax`](ExpressionSyntax.md) + +The maximum number of minutes to run the step before killing the process. + +### uses? + +> `optional` **uses?**: `string` + +Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/). +We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. +- Using the commit SHA of a released action version is the safest for stability and security. +- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. +- Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break. +Some actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required. +Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions. + +### wait? + +> `optional` **wait?**: `string` \| \[`string`, `...string[]`\] + +Pauses the job until one or more background steps complete. Provide a single step id as a string, or multiple step ids as an array. After a wait step completes, the outputs of the referenced background steps become available to subsequent steps. + +### wait-all? + +> `optional` **wait-all?**: `boolean` \| `null` + +Pauses the job until all active background steps complete. The wait-all keyword takes no arguments. + +### with? + +> `optional` **with?**: [`Env`](Env.md) + +### working-directory? + +> `optional` **working-directory?**: [`WorkingDirectory`](WorkingDirectory.md) + +## Type Declaration + +### background? + +> `optional` **background?**: `boolean` + +Runs a step asynchronously so the job continues to the next step without waiting for it to finish. You can use background on steps that use run or uses. To reference a background step from wait or cancel, give it an id. A maximum of 10 background steps can run concurrently in a single job. + +### cancel? + +> `optional` **cancel?**: `string` + +Gracefully terminates a running background step. The runner sends the step's process a termination signal (SIGTERM) so it can clean up. The cancel keyword targets a single background step by its id. + ### continue-on-error? -> `optional` **continue-on-error**: `boolean` \| [`ExpressionSyntax`](ExpressionSyntax.md) +> `optional` **continue-on-error?**: `boolean` \| [`ExpressionSyntax`](ExpressionSyntax.md) Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails. ### env? -> `optional` **env**: \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} \| [`StringContainingExpressionSyntax`](StringContainingExpressionSyntax.md) +> `optional` **env?**: \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} \| [`StringContainingExpressionSyntax`](StringContainingExpressionSyntax.md) Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job. ### id? -> `optional` **id**: `string` +> `optional` **id?**: `string` A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. ### if? -> `optional` **if**: `boolean` \| `number` \| `string` +> `optional` **if?**: `boolean` \| `number` \| `string` You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional. Expressions in an if conditional do not require the $\{\{ \}\} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. ### name? -> `optional` **name**: `string` +> `optional` **name?**: `string` A name for your step to display on GitHub. +### parallel? + +> `optional` **parallel?**: \[`Step`, `...Step[]`\] + +Runs a group of steps concurrently, then waits for all of them to finish before continuing. Every step in the group runs as a background step, with an implicit wait at the end of the group. + ### run? -> `optional` **run**: `string` +> `optional` **run?**: `string` Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command. Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell. @@ -53,17 +273,17 @@ Each run keyword represents a new process and shell in the virtual environment. ### shell? -> `optional` **shell**: [`Shell`](Shell.md) +> `optional` **shell?**: [`Shell`](Shell.md) ### timeout-minutes? -> `optional` **timeout-minutes**: `number` \| [`ExpressionSyntax`](ExpressionSyntax.md) +> `optional` **timeout-minutes?**: `number` \| [`ExpressionSyntax`](ExpressionSyntax.md) The maximum number of minutes to run the step before killing the process. ### uses? -> `optional` **uses**: `string` +> `optional` **uses?**: `string` Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/). We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. @@ -73,50 +293,80 @@ We strongly recommend that you include the version of the action you are using b Some actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required. Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions. +### wait? + +> `optional` **wait?**: `string` \| \[`string`, `...string[]`\] + +Pauses the job until one or more background steps complete. Provide a single step id as a string, or multiple step ids as an array. After a wait step completes, the outputs of the referenced background steps become available to subsequent steps. + +### wait-all? + +> `optional` **wait-all?**: `boolean` \| `null` + +Pauses the job until all active background steps complete. The wait-all keyword takes no arguments. + ### with? -> `optional` **with**: [`Env`](Env.md) +> `optional` **with?**: [`Env`](Env.md) ### working-directory? -> `optional` **working-directory**: [`WorkingDirectory`](WorkingDirectory.md) +> `optional` **working-directory?**: [`WorkingDirectory`](WorkingDirectory.md) ## Type Declaration +### background? + +> `optional` **background?**: `boolean` + +Runs a step asynchronously so the job continues to the next step without waiting for it to finish. You can use background on steps that use run or uses. To reference a background step from wait or cancel, give it an id. A maximum of 10 background steps can run concurrently in a single job. + +### cancel? + +> `optional` **cancel?**: `string` + +Gracefully terminates a running background step. The runner sends the step's process a termination signal (SIGTERM) so it can clean up. The cancel keyword targets a single background step by its id. + ### continue-on-error? -> `optional` **continue-on-error**: `boolean` \| [`ExpressionSyntax`](ExpressionSyntax.md) +> `optional` **continue-on-error?**: `boolean` \| [`ExpressionSyntax`](ExpressionSyntax.md) Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails. ### env? -> `optional` **env**: \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} \| [`StringContainingExpressionSyntax`](StringContainingExpressionSyntax.md) +> `optional` **env?**: \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} \| [`StringContainingExpressionSyntax`](StringContainingExpressionSyntax.md) Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job. ### id? -> `optional` **id**: `string` +> `optional` **id?**: `string` A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. ### if? -> `optional` **if**: `boolean` \| `number` \| `string` +> `optional` **if?**: `boolean` \| `number` \| `string` You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional. Expressions in an if conditional do not require the $\{\{ \}\} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. ### name? -> `optional` **name**: `string` +> `optional` **name?**: `string` A name for your step to display on GitHub. +### parallel? + +> `optional` **parallel?**: \[`Step`, `...Step[]`\] + +Runs a group of steps concurrently, then waits for all of them to finish before continuing. Every step in the group runs as a background step, with an implicit wait at the end of the group. + ### run? -> `optional` **run**: `string` +> `optional` **run?**: `string` Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command. Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell. @@ -124,17 +374,17 @@ Each run keyword represents a new process and shell in the virtual environment. ### shell? -> `optional` **shell**: [`Shell`](Shell.md) +> `optional` **shell?**: [`Shell`](Shell.md) ### timeout-minutes? -> `optional` **timeout-minutes**: `number` \| [`ExpressionSyntax`](ExpressionSyntax.md) +> `optional` **timeout-minutes?**: `number` \| [`ExpressionSyntax`](ExpressionSyntax.md) The maximum number of minutes to run the step before killing the process. ### uses? -> `optional` **uses**: `string` +> `optional` **uses?**: `string` Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/). We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. @@ -144,10 +394,22 @@ We strongly recommend that you include the version of the action you are using b Some actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required. Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions. +### wait? + +> `optional` **wait?**: `string` \| \[`string`, `...string[]`\] + +Pauses the job until one or more background steps complete. Provide a single step id as a string, or multiple step ids as an array. After a wait step completes, the outputs of the referenced background steps become available to subsequent steps. + +### wait-all? + +> `optional` **wait-all?**: `boolean` \| `null` + +Pauses the job until all active background steps complete. The wait-all keyword takes no arguments. + ### with? -> `optional` **with**: [`Env`](Env.md) +> `optional` **with?**: [`Env`](Env.md) ### working-directory? -> `optional` **working-directory**: [`WorkingDirectory`](WorkingDirectory.md) +> `optional` **working-directory?**: [`WorkingDirectory`](WorkingDirectory.md) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Step1.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Step1.md index 002cfab..afc8a8e 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Step1.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Step1.md @@ -6,6 +6,6 @@ # Type Alias: Step1 -> **Step1** = \{\[`k`: `string`\]: `unknown`; \} \| \{\[`k`: `string`\]: `unknown`; \} +> **Step1** = \{\[`k`: `string`\]: `unknown`; \} \| \{\[`k`: `string`\]: `unknown`; \} \| \{\[`k`: `string`\]: `unknown`; \} \| \{\[`k`: `string`\]: `unknown`; \} \| \{\[`k`: `string`\]: `unknown`; \} \| \{\[`k`: `string`\]: `unknown`; \} -Defined in: [types/githubActionsWorkflow.ts:485](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L485) +Defined in: [types/githubActionsWorkflow.ts:841](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L841) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/StringContainingExpressionSyntax.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/StringContainingExpressionSyntax.md index 2058991..3552c1a 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/StringContainingExpressionSyntax.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/StringContainingExpressionSyntax.md @@ -8,4 +8,4 @@ > **StringContainingExpressionSyntax** = `string` -Defined in: [types/githubActionsWorkflow.ts:339](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L339) +Defined in: [types/githubActionsWorkflow.ts:513](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L513) diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WatchEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WatchEvent.md index 19e1f25..36952fc 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WatchEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WatchEvent.md @@ -8,6 +8,6 @@ > **WatchEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:286](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L286) +Defined in: [types/githubActionsWorkflow.ts:450](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L450) 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/. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowDispatchInput.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowDispatchInput.md index bf45053..b151654 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowDispatchInput.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowDispatchInput.md @@ -8,7 +8,7 @@ > **WorkflowDispatchInput** = `object` & `object` -Defined in: [types/githubActionsWorkflow.ts:295](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L295) +Defined in: [types/githubActionsWorkflow.ts:459](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L459) A string identifier to associate with the input. The value of \ is a map of the input's metadata. The \ must be a unique identifier within the inputs object. The \ must start with a letter or _ and contain only alphanumeric characters, -, or _. @@ -19,7 +19,7 @@ via the `patternProperty` "^[_a-zA-Z][a-zA-Z0-9_-]*$". ### default? -> `optional` **default**: `object` +> `optional` **default?**: `object` A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file. @@ -29,30 +29,30 @@ A string representing the default value. The default value is used when an input ### deprecationMessage? -> `optional` **deprecationMessage**: `string` +> `optional` **deprecationMessage?**: `string` A string shown to users using the deprecated input. ### description? -> `optional` **description**: `string` +> `optional` **description?**: `string` A string description of the input parameter. ### options? -> `optional` **options**: \[`string`, `...string[]`\] +> `optional` **options?**: \[`string`, `...string[]`\] The options of the dropdown list, if the type is a choice. ### required? -> `optional` **required**: `boolean` +> `optional` **required?**: `boolean` A boolean to indicate whether the action requires the input parameter. Set to true when the parameter is required. ### type? -> `optional` **type**: `"string"` \| `"choice"` \| `"boolean"` \| `"number"` \| `"environment"` +> `optional` **type?**: `"string"` \| `"choice"` \| `"boolean"` \| `"number"` \| `"environment"` A string representing the type of the input. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowRunEvent.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowRunEvent.md index 1d02a90..6b1d05e 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowRunEvent.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowRunEvent.md @@ -6,8 +6,8 @@ # Type Alias: WorkflowRunEvent -> **WorkflowRunEvent** = \{\[`k`: `string`\]: `unknown`; \} \| `null` +> **WorkflowRunEvent** = \{\[`k`: `string`\]: `unknown`; `types?`: [`WorkflowRunEventTypes`](WorkflowRunEventTypes.md); `workflows?`: \[`string`, `...string[]`\]; \} \| `null` -Defined in: [types/githubActionsWorkflow.ts:329](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L329) +Defined in: [types/githubActionsWorkflow.ts:493](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L493) 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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowRunEventTypes.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowRunEventTypes.md new file mode 100644 index 0000000..cb0f354 --- /dev/null +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkflowRunEventTypes.md @@ -0,0 +1,14 @@ +[**@github-actions-workflow-ts/lib**](../../../../README.md) + +*** + +[@github-actions-workflow-ts/lib](../../../../README.md) / [GeneratedWorkflowTypes](../README.md) / WorkflowRunEventTypes + +# Type Alias: WorkflowRunEventTypes + +> **WorkflowRunEventTypes** = \[`unknown`, `...unknown[]`\] \| `string` & (`"requested"` \| `"completed"` \| `"in_progress"`)[] + +Defined in: [types/githubActionsWorkflow.ts:504](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L504) + +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. +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. diff --git a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkingDirectory.md b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkingDirectory.md index 299db7c..69aada9 100644 --- a/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkingDirectory.md +++ b/docs/docs/api-reference/@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/WorkingDirectory.md @@ -8,6 +8,6 @@ > **WorkingDirectory** = `string` -Defined in: [types/githubActionsWorkflow.ts:349](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/types/githubActionsWorkflow.ts#L349) +Defined in: [types/githubActionsWorkflow.ts:523](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/types/githubActionsWorkflow.ts#L523) Using the working-directory keyword, you can specify the working directory of where to run the command. diff --git a/docs/docs/api-reference/README.md b/docs/docs/api-reference/README.md index b32b185..7e115d7 100644 --- a/docs/docs/api-reference/README.md +++ b/docs/docs/api-reference/README.md @@ -22,6 +22,12 @@ | [Step](classes/Step.md) | Represents a single step within a GitHub Actions job. | | [Workflow](classes/Workflow.md) | Represents a GitHub Actions workflow. | +## Type Aliases + +| Type Alias | Description | +| ------ | ------ | +| [WorkflowOptions](type-aliases/WorkflowOptions.md) | Options for configuring a Workflow instance. | + ## Variables | Variable | Description | diff --git a/docs/docs/api-reference/classes/NormalJob.md b/docs/docs/api-reference/classes/NormalJob.md index 8a4b781..45bcc55 100644 --- a/docs/docs/api-reference/classes/NormalJob.md +++ b/docs/docs/api-reference/classes/NormalJob.md @@ -6,7 +6,7 @@ # Class: NormalJob -Defined in: [job/index.ts:18](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L18) +Defined in: [job/index.ts:18](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L18) Represents a standard GitHub Actions job that runs on a specified runner. @@ -28,7 +28,7 @@ testJob.addStep(new Step({ name: 'Checkout', uses: 'actions/checkout@v4' })) > **new NormalJob**(`name`, `jobProps`): `NormalJob` -Defined in: [job/index.ts:63](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L63) +Defined in: [job/index.ts:63](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L63) #### Parameters @@ -50,7 +50,7 @@ Defined in: [job/index.ts:63](https://github.com/emmanuelnk/github-actions-workf > **job**: [`NormalJob`](../@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/NormalJob.md) -Defined in: [job/index.ts:20](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L20) +Defined in: [job/index.ts:20](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L20) *** @@ -58,7 +58,7 @@ Defined in: [job/index.ts:20](https://github.com/emmanuelnk/github-actions-workf > **name**: `string` -Defined in: [job/index.ts:19](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L19) +Defined in: [job/index.ts:19](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L19) *** @@ -66,7 +66,7 @@ Defined in: [job/index.ts:19](https://github.com/emmanuelnk/github-actions-workf > **steps**: [`Step`](../@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Step.md)[] = `[]` -Defined in: [job/index.ts:21](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L21) +Defined in: [job/index.ts:21](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L21) ## Methods @@ -74,13 +74,13 @@ Defined in: [job/index.ts:21](https://github.com/emmanuelnk/github-actions-workf > **addEnvs**(`envs`): `this` -Defined in: [job/index.ts:23](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L23) +Defined in: [job/index.ts:23](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L23) #### Parameters ##### envs -`string` | \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} | `undefined` +`string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} \| `undefined` #### Returns @@ -92,7 +92,7 @@ Defined in: [job/index.ts:23](https://github.com/emmanuelnk/github-actions-workf > **addStep**(`step`): `this` -Defined in: [job/index.ts:42](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L42) +Defined in: [job/index.ts:42](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L42) #### Parameters @@ -110,7 +110,7 @@ Defined in: [job/index.ts:42](https://github.com/emmanuelnk/github-actions-workf > **addSteps**(`steps`): `this` -Defined in: [job/index.ts:34](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L34) +Defined in: [job/index.ts:34](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L34) #### Parameters @@ -128,7 +128,7 @@ Defined in: [job/index.ts:34](https://github.com/emmanuelnk/github-actions-workf > **needs**(`jobs`): `this` -Defined in: [job/index.ts:49](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L49) +Defined in: [job/index.ts:49](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L49) #### Parameters diff --git a/docs/docs/api-reference/classes/ReusableWorkflowCallJob.md b/docs/docs/api-reference/classes/ReusableWorkflowCallJob.md index 1d2c228..85ab4d7 100644 --- a/docs/docs/api-reference/classes/ReusableWorkflowCallJob.md +++ b/docs/docs/api-reference/classes/ReusableWorkflowCallJob.md @@ -6,7 +6,7 @@ # Class: ReusableWorkflowCallJob -Defined in: [job/index.ts:83](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L83) +Defined in: [job/index.ts:83](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L83) Represents a job that calls a reusable workflow. @@ -28,7 +28,7 @@ const deployJob = new ReusableWorkflowCallJob('deploy', { > **new ReusableWorkflowCallJob**(`name`, `jobProps`): `ReusableWorkflowCallJob` -Defined in: [job/index.ts:101](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L101) +Defined in: [job/index.ts:101](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L101) #### Parameters @@ -50,7 +50,7 @@ Defined in: [job/index.ts:101](https://github.com/emmanuelnk/github-actions-work > **job**: [`ReusableWorkflowCallJob`](../@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/ReusableWorkflowCallJob.md) -Defined in: [job/index.ts:85](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L85) +Defined in: [job/index.ts:85](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L85) *** @@ -58,7 +58,7 @@ Defined in: [job/index.ts:85](https://github.com/emmanuelnk/github-actions-workf > **name**: `string` -Defined in: [job/index.ts:84](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L84) +Defined in: [job/index.ts:84](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L84) ## Methods @@ -66,7 +66,7 @@ Defined in: [job/index.ts:84](https://github.com/emmanuelnk/github-actions-workf > **needs**(`jobs`): `this` -Defined in: [job/index.ts:87](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/job/index.ts#L87) +Defined in: [job/index.ts:87](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/job/index.ts#L87) #### Parameters diff --git a/docs/docs/api-reference/classes/Step.md b/docs/docs/api-reference/classes/Step.md index 712690e..ab9e060 100644 --- a/docs/docs/api-reference/classes/Step.md +++ b/docs/docs/api-reference/classes/Step.md @@ -6,7 +6,7 @@ # Class: Step -Defined in: [step/index.ts:18](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/step/index.ts#L18) +Defined in: [step/index.ts:18](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/step/index.ts#L18) Represents a single step within a GitHub Actions job. @@ -29,7 +29,7 @@ const checkoutStep = new Step({ name: 'Checkout', uses: 'actions/checkout@v4' }) > **new Step**(`stepProps`): `Step` -Defined in: [step/index.ts:35](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/step/index.ts#L35) +Defined in: [step/index.ts:35](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/step/index.ts#L35) #### Parameters @@ -47,7 +47,7 @@ Defined in: [step/index.ts:35](https://github.com/emmanuelnk/github-actions-work > **id**: `string` \| `undefined` -Defined in: [step/index.ts:20](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/step/index.ts#L20) +Defined in: [step/index.ts:20](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/step/index.ts#L20) *** @@ -55,7 +55,7 @@ Defined in: [step/index.ts:20](https://github.com/emmanuelnk/github-actions-work > **step**: [`Step`](../@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/type-aliases/Step.md) -Defined in: [step/index.ts:19](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/step/index.ts#L19) +Defined in: [step/index.ts:19](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/step/index.ts#L19) ## Methods @@ -63,13 +63,13 @@ Defined in: [step/index.ts:19](https://github.com/emmanuelnk/github-actions-work > **addEnvs**(`envs`): `this` -Defined in: [step/index.ts:22](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/step/index.ts#L22) +Defined in: [step/index.ts:22](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/step/index.ts#L22) #### Parameters ##### envs -(string \| \{ \[k: string\]: string \| number \| boolean; \}) & (string \| \{ \[k: string\]: string \| number \| boolean; \}) | `undefined` +((string \| \{ \[k: string\]: string \| number \| boolean; \}) & (string \| \{ \[k: string\]: string \| number \| boolean; \})) & ((string \| \{ \[k: string\]: string \| number \| boolean; \}) & (string \| \{ ...; \})) \| `undefined` #### Returns diff --git a/docs/docs/api-reference/classes/Workflow.md b/docs/docs/api-reference/classes/Workflow.md index cee4c42..be15afa 100644 --- a/docs/docs/api-reference/classes/Workflow.md +++ b/docs/docs/api-reference/classes/Workflow.md @@ -6,14 +6,14 @@ # Class: Workflow -Defined in: [workflow/index.ts:19](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/workflow/index.ts#L19) +Defined in: [workflow/index.ts:41](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/workflow/index.ts#L41) Represents a GitHub Actions workflow. The Workflow class is the top-level container for defining a GitHub Actions workflow. It allows you to configure workflow triggers, add jobs, and set environment variables. -## Example +## Examples ```typescript const workflow = new Workflow('ci', { @@ -23,13 +23,21 @@ const workflow = new Workflow('ci', { workflow.addJob(testJob) ``` +```typescript +// With custom output path +const workflow = new Workflow('deploy', { + name: 'Deploy', + on: { push: { branches: ['main'] } }, +}, { outputPath: 'packages/app-a/.github/workflows' }) +``` + ## Constructors ### Constructor -> **new Workflow**(`filename`, `workflowProps`): `Workflow` +> **new Workflow**(`filename`, `workflowProps`, `options?`): `Workflow` -Defined in: [workflow/index.ts:58](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/workflow/index.ts#L58) +Defined in: [workflow/index.ts:86](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/workflow/index.ts#L86) #### Parameters @@ -41,6 +49,10 @@ Defined in: [workflow/index.ts:58](https://github.com/emmanuelnk/github-actions- `Partial`<[`Workflow`](../@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Workflow.md)> +##### options? + +[`WorkflowOptions`](../type-aliases/WorkflowOptions.md) + #### Returns `Workflow` @@ -49,19 +61,30 @@ Defined in: [workflow/index.ts:58](https://github.com/emmanuelnk/github-actions- ### filename? -> `optional` **filename**: `string` +> `optional` **filename?**: `string` -Defined in: [workflow/index.ts:25](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/workflow/index.ts#L25) +Defined in: [workflow/index.ts:47](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/workflow/index.ts#L47) The filename of the workflow e.g. `main.yml` *** +### outputPath? + +> `optional` **outputPath?**: `string` + +Defined in: [workflow/index.ts:53](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/workflow/index.ts#L53) + +Custom output path for this workflow. +If set, overrides any config file settings. + +*** + ### workflow > **workflow**: `Partial`<[`Workflow`](../@github-actions-workflow-ts/namespaces/GeneratedWorkflowTypes/interfaces/Workflow.md)> -Defined in: [workflow/index.ts:20](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/workflow/index.ts#L20) +Defined in: [workflow/index.ts:42](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/workflow/index.ts#L42) ## Methods @@ -69,13 +92,13 @@ Defined in: [workflow/index.ts:20](https://github.com/emmanuelnk/github-actions- > **addEnvs**(`envs`): `this` -Defined in: [workflow/index.ts:27](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/workflow/index.ts#L27) +Defined in: [workflow/index.ts:55](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/workflow/index.ts#L55) #### Parameters ##### envs -`string` | \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} | `undefined` +`string` \| \{\[`k`: `string`\]: `string` \| `number` \| `boolean`; \} \| `undefined` #### Returns @@ -87,13 +110,13 @@ Defined in: [workflow/index.ts:27](https://github.com/emmanuelnk/github-actions- > **addJob**(`job`): `this` -Defined in: [workflow/index.ts:49](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/workflow/index.ts#L49) +Defined in: [workflow/index.ts:77](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/workflow/index.ts#L77) #### Parameters ##### job -[`NormalJob`](NormalJob.md) | [`ReusableWorkflowCallJob`](ReusableWorkflowCallJob.md) +[`NormalJob`](NormalJob.md) \| [`ReusableWorkflowCallJob`](ReusableWorkflowCallJob.md) #### Returns @@ -105,7 +128,7 @@ Defined in: [workflow/index.ts:49](https://github.com/emmanuelnk/github-actions- > **addJobs**(`jobs`): `this` -Defined in: [workflow/index.ts:40](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/workflow/index.ts#L40) +Defined in: [workflow/index.ts:68](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/workflow/index.ts#L68) #### Parameters diff --git a/docs/docs/api-reference/functions/dedentString.md b/docs/docs/api-reference/functions/dedentString.md index 4f1eb19..9767828 100644 --- a/docs/docs/api-reference/functions/dedentString.md +++ b/docs/docs/api-reference/functions/dedentString.md @@ -8,7 +8,7 @@ > **dedentString**(`str`): `string` -Defined in: [utils/index.ts:178](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/utils/index.ts#L178) +Defined in: [utils/index.ts:178](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/utils/index.ts#L178) Strips leading whitespace from a template literal string while preserving relative indentation. Useful for writing inline multi-line strings (like scripts) that render cleanly in YAML. diff --git a/docs/docs/api-reference/functions/multilineString.md b/docs/docs/api-reference/functions/multilineString.md index afd3643..741d869 100644 --- a/docs/docs/api-reference/functions/multilineString.md +++ b/docs/docs/api-reference/functions/multilineString.md @@ -8,7 +8,7 @@ > **multilineString**(...`strings`): `string` -Defined in: [utils/index.ts:145](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/utils/index.ts#L145) +Defined in: [utils/index.ts:145](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/utils/index.ts#L145) Joins multiple strings with newline characters to create a multi-line YAML string. diff --git a/docs/docs/api-reference/type-aliases/WorkflowOptions.md b/docs/docs/api-reference/type-aliases/WorkflowOptions.md new file mode 100644 index 0000000..9529de7 --- /dev/null +++ b/docs/docs/api-reference/type-aliases/WorkflowOptions.md @@ -0,0 +1,31 @@ +[**@github-actions-workflow-ts/lib**](../README.md) + +*** + +[@github-actions-workflow-ts/lib](../README.md) / WorkflowOptions + +# Type Alias: WorkflowOptions + +> **WorkflowOptions** = `object` + +Defined in: [workflow/index.ts:7](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/workflow/index.ts#L7) + +Options for configuring a Workflow instance. + +## Properties + +### outputPath? + +> `optional` **outputPath?**: `string` + +Defined in: [workflow/index.ts:14](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/workflow/index.ts#L14) + +Custom output path for this workflow. +If specified, takes precedence over config file settings. +Can be a relative or absolute path to the output directory. + +#### Example + +```ts +"packages/app-a/.github/workflows" +``` diff --git a/docs/docs/api-reference/variables/echoKeyValue.md b/docs/docs/api-reference/variables/echoKeyValue.md index 4a92e27..66fd4cc 100644 --- a/docs/docs/api-reference/variables/echoKeyValue.md +++ b/docs/docs/api-reference/variables/echoKeyValue.md @@ -8,7 +8,7 @@ > `const` **echoKeyValue**: `object` -Defined in: [utils/index.ts:74](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/utils/index.ts#L74) +Defined in: [utils/index.ts:74](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/utils/index.ts#L74) Utility methods to echo key-value pairs to various targets. diff --git a/docs/docs/api-reference/variables/expressions.md b/docs/docs/api-reference/variables/expressions.md index b2fbe02..b11831a 100644 --- a/docs/docs/api-reference/variables/expressions.md +++ b/docs/docs/api-reference/variables/expressions.md @@ -8,7 +8,7 @@ > `const` **expressions**: `object` -Defined in: [utils/index.ts:4](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/utils/index.ts#L4) +Defined in: [utils/index.ts:4](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/utils/index.ts#L4) Utility methods to generate specific Github Actions workflow expressions. @@ -19,7 +19,7 @@ Utility methods to generate specific Github Actions workflow expressions. > **env**(`envName`): `string` Generates an environment variable expression -i.e. `${{ env. }}` +i.e. `${{ env.<envName> }}` Ref: https://docs.github.com/en/actions/learn-github-actions/expressions @@ -42,7 +42,7 @@ The formatted environment variable reference. > **expn**(`expression`): `string` Wraps the provided expression inside a special format understood by Github Actions -i.e. `${{ }}` +i.e. `${{ <expression> }}` Ref: https://docs.github.com/en/actions/learn-github-actions/expressions @@ -65,7 +65,7 @@ The wrapped expression. > **secret**(`secretName`): `string` Generates a secrets expression -i.e. `${{ secrets. }}` +i.e. `${{ secrets.<secretName> }}` Ref: https://docs.github.com/en/actions/learn-github-actions/expressions @@ -88,7 +88,7 @@ The formatted secret reference. > **ternary**(`condition`, `ifTrue`, `ifFalse`): `string` Generates a YAML compatible ternary operation -i.e. `${{ && || }}` +i.e. `${{ <condition> && <ifTrue> || <ifFalse> }}` #### Parameters @@ -121,7 +121,7 @@ The formatted ternary operation. > **var**(`varName`): `string` Generates a variables expression -i.e. `${{ vars. }}` +i.e. `${{ vars.<varName> }}` Ref: https://docs.github.com/en/actions/learn-github-actions/expressions diff --git a/docs/docs/api-reference/variables/workflowOps.md b/docs/docs/api-reference/variables/workflowOps.md index 2cfb907..9a6f2f1 100644 --- a/docs/docs/api-reference/variables/workflowOps.md +++ b/docs/docs/api-reference/variables/workflowOps.md @@ -8,7 +8,7 @@ > `const` **workflowOps**: `object` -Defined in: [utils/index.ts:212](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/eb791f98a5c7871cf5c52fc4e1567bf9fe1afcd1/packages/lib/src/utils/index.ts#L212) +Defined in: [utils/index.ts:212](https://github.com/emmanuelnk/github-actions-workflow-ts/blob/204cfff36f251549b6101484013006e38b3d20bf/packages/lib/src/utils/index.ts#L212) Utility methods related to GitHub workflow operations. @@ -49,4 +49,4 @@ The formatted ternary operation. since version 0.2.0 use `expressions.ternary` instead. Generates a YAML compatible ternary operation -i.e. `${{ && || }}` +i.e. `${{ <condition> && <ifTrue> || <ifFalse> }}`