@pulumi/github 5.26.0-alpha.1705643777 → 5.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pulumi/github",
-    "version": "v5.26.0-alpha.1705643777+e763d42d",
+    "version": "v5.26.0",
     "description": "A Pulumi package for creating and managing github cloud resources.",
     "keywords": [
         "pulumi",

package/repositoryFile.d.ts

@@ -81,7 +81,7 @@ export declare class RepositoryFile extends pulumi.CustomResource {
      */
     readonly file: pulumi.Output<string>;
     /**
-     * Enable overwriting existing files
+     * Enable overwriting existing files. If set to `true` it will overwrite an existing file with the same name. If set to `false` it will fail if there is an existing file with the same name.
      */
     readonly overwriteOnCreate: pulumi.Output<boolean | undefined>;
     /**
@@ -139,7 +139,7 @@ export interface RepositoryFileState {
      */
     file?: pulumi.Input<string>;
     /**
-     * Enable overwriting existing files
+     * Enable overwriting existing files. If set to `true` it will overwrite an existing file with the same name. If set to `false` it will fail if there is an existing file with the same name.
      */
     overwriteOnCreate?: pulumi.Input<boolean>;
     /**
@@ -185,7 +185,7 @@ export interface RepositoryFileArgs {
      */
     file: pulumi.Input<string>;
     /**
-     * Enable overwriting existing files
+     * Enable overwriting existing files. If set to `true` it will overwrite an existing file with the same name. If set to `false` it will fail if there is an existing file with the same name.
      */
     overwriteOnCreate?: pulumi.Input<boolean>;
     /**

package/types/input.d.ts

@@ -68,6 +68,11 @@ export interface BranchProtectionRequiredPullRequestReview {
 export interface BranchProtectionRequiredStatusCheck {
     /**
      * The list of status checks to require in order to merge into this branch. No status checks are required by default.
+     *
+     * > Note: This attribute can contain multiple string patterns.
+     * If specified, usual value is the [job name](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idname). Otherwise, the [job id](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idname) is defaulted to.
+     * For workflows that use matrixes, append the matrix name to the value using the following pattern `(<matrix_value>[, <matrix_value>])`. Matrixes should be specified based on the order of matrix properties in the workflow file. See GitHub Documentation for more information.
+     * For workflows that use reusable workflows, the pattern is `<initial_workflow.jobs.job.[name/id]> / <reused-workflow.jobs.job.[name/id]>`. This can extend multiple levels.
      */
     contexts?: pulumi.Input<pulumi.Input<string>[]>;
     /**
@@ -132,6 +137,11 @@ export interface BranchProtectionV3RequiredStatusChecks {
     /**
      * [**DEPRECATED**] (Optional) The list of status checks to require in order to merge into this branch. No status checks are required by default.
      *
+     * > Note: This attribute can contain multiple string patterns.
+     * If specified, usual value is the [job name](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idname). Otherwise, the [job id](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idname) is defaulted to.
+     * For workflows that use matrixes, append the matrix name to the value using the following pattern `(<matrix_value>[, <matrix_value>])`. Matrixes should be specified based on the order of matrix properties in the workflow file. See GitHub Documentation for more information.
+     * For workflows that use reusable workflows, the pattern is `<initial_workflow.jobs.job.[name/id]> / <reused-workflow.jobs.job.[name/id]>`. This can extend multiple levels.
+     *
      * @deprecated GitHub is deprecating the use of `contexts`. Use a `checks` array instead.
      */
     contexts?: pulumi.Input<pulumi.Input<string>[]>;
@@ -277,6 +287,10 @@ export interface OrganizationRulesetRules {
      * (Block List, Max: 1) Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. (see below for nested schema)
      */
     requiredStatusChecks?: pulumi.Input<inputs.OrganizationRulesetRulesRequiredStatusChecks>;
+    /**
+     * (Block List, Max: 1) Define which Actions workflows must pass before changes can be merged into a branch matching the rule. Multiple workflows can be specified. (see below for nested schema)
+     */
+    requiredWorkflows?: pulumi.Input<inputs.OrganizationRulesetRulesRequiredWorkflows>;
     /**
      * (Block List, Max: 1) Parameters to be used for the tagNamePattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with `branchNamePattern` as it only applies to rulesets with target `tag`. (see below for nested schema)
      */
@@ -400,6 +414,26 @@ export interface OrganizationRulesetRulesRequiredStatusChecksRequiredCheck {
      */
     integrationId?: pulumi.Input<number>;
 }
+export interface OrganizationRulesetRulesRequiredWorkflows {
+    /**
+     * (Block Set, Min: 1) Actions workflows that are required. Multiple can be defined. (see below for nested schema)
+     */
+    requiredWorkflows: pulumi.Input<pulumi.Input<inputs.OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow>[]>;
+}
+export interface OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow {
+    /**
+     * (String) The path to the YAML definition file of the workflow.
+     */
+    path: pulumi.Input<string>;
+    /**
+     * (String) The optional ref from which to fetch the workflow. Defaults to `master`.
+     */
+    ref?: pulumi.Input<string>;
+    /**
+     * The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. Conflicts with `repositoryName`.
+     */
+    repositoryId: pulumi.Input<number>;
+}
 export interface OrganizationRulesetRulesTagNamePattern {
     /**
      * (String) The name of the ruleset.

package/types/output.d.ts

@@ -67,6 +67,11 @@ export interface BranchProtectionRequiredPullRequestReview {
 export interface BranchProtectionRequiredStatusCheck {
     /**
      * The list of status checks to require in order to merge into this branch. No status checks are required by default.
+     *
+     * > Note: This attribute can contain multiple string patterns.
+     * If specified, usual value is the [job name](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idname). Otherwise, the [job id](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idname) is defaulted to.
+     * For workflows that use matrixes, append the matrix name to the value using the following pattern `(<matrix_value>[, <matrix_value>])`. Matrixes should be specified based on the order of matrix properties in the workflow file. See GitHub Documentation for more information.
+     * For workflows that use reusable workflows, the pattern is `<initial_workflow.jobs.job.[name/id]> / <reused-workflow.jobs.job.[name/id]>`. This can extend multiple levels.
      */
     contexts?: string[];
     /**
@@ -131,6 +136,11 @@ export interface BranchProtectionV3RequiredStatusChecks {
     /**
      * [**DEPRECATED**] (Optional) The list of status checks to require in order to merge into this branch. No status checks are required by default.
      *
+     * > Note: This attribute can contain multiple string patterns.
+     * If specified, usual value is the [job name](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idname). Otherwise, the [job id](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idname) is defaulted to.
+     * For workflows that use matrixes, append the matrix name to the value using the following pattern `(<matrix_value>[, <matrix_value>])`. Matrixes should be specified based on the order of matrix properties in the workflow file. See GitHub Documentation for more information.
+     * For workflows that use reusable workflows, the pattern is `<initial_workflow.jobs.job.[name/id]> / <reused-workflow.jobs.job.[name/id]>`. This can extend multiple levels.
+     *
      * @deprecated GitHub is deprecating the use of `contexts`. Use a `checks` array instead.
      */
     contexts?: string[];
@@ -1031,6 +1041,10 @@ export interface OrganizationRulesetRules {
      * (Block List, Max: 1) Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. (see below for nested schema)
      */
     requiredStatusChecks?: outputs.OrganizationRulesetRulesRequiredStatusChecks;
+    /**
+     * (Block List, Max: 1) Define which Actions workflows must pass before changes can be merged into a branch matching the rule. Multiple workflows can be specified. (see below for nested schema)
+     */
+    requiredWorkflows?: outputs.OrganizationRulesetRulesRequiredWorkflows;
     /**
      * (Block List, Max: 1) Parameters to be used for the tagNamePattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with `branchNamePattern` as it only applies to rulesets with target `tag`. (see below for nested schema)
      */
@@ -1154,6 +1168,26 @@ export interface OrganizationRulesetRulesRequiredStatusChecksRequiredCheck {
      */
     integrationId?: number;
 }
+export interface OrganizationRulesetRulesRequiredWorkflows {
+    /**
+     * (Block Set, Min: 1) Actions workflows that are required. Multiple can be defined. (see below for nested schema)
+     */
+    requiredWorkflows: outputs.OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[];
+}
+export interface OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow {
+    /**
+     * (String) The path to the YAML definition file of the workflow.
+     */
+    path: string;
+    /**
+     * (String) The optional ref from which to fetch the workflow. Defaults to `master`.
+     */
+    ref?: string;
+    /**
+     * The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. Conflicts with `repositoryName`.
+     */
+    repositoryId: number;
+}
 export interface OrganizationRulesetRulesTagNamePattern {
     /**
      * (String) The name of the ruleset.