https://projen.io/assets/js/b2c731da.36611d23.js

1"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([["3241"],{9732(e,n,i){i.r(n),i.d(n,{metadata:()=>r,default:()=>a,frontMatter:()=>o,contentTitle:()=>d,toc:()=>c,assets:()=>l});var r=JSON.parse('{"id":"api/github","title":"github Submodule <a name=\\"github Submodule\\" id=\\"projen.github\\"></a>","description":"Constructs","source":"@site/../docs/api/github.md","sourceDirName":"api","slug":"/api/github","permalink":"/docs/api/github","draft":false,"unlisted":false,"editUrl":"https://github.com/projen/projen/tree/main/docusaurus/../docs/api/github.md","tags":[],"version":"current","frontMatter":{},"sidebar":"apiSidebar","previous":{"title":"circleci","permalink":"/docs/api/circleci"},"next":{"title":"github.workflows","permalink":"/docs/api/github.workflows"}}'),s=i(4848),t=i(8453);let o={},d='github Submodule <a name="`github` Submodule" id="projen.github"></a>',l={},c=[{value:'Constructs <a name="Constructs" id="Constructs"></a>',id:"constructs-",level:2},{value:'AutoApprove <a name="AutoApprove" id="projen.github.AutoApprove"></a>',id:"autoapprove-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.AutoApprove.Initializer"></a>',id:"initializers-",level:4},{value:'<code>github</code><sup>Required</sup> <a name="github" id="projen.github.AutoApprove.Initializer.parameter.github"></a>',id:"githubrequired-",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.AutoApprove.Initializer.parameter.options"></a>',id:"optionsoptional-",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods-",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.AutoApprove.toString"></a>',id:"tostring-",level:5},{value:'<code>with</code> <a name="with" id="projen.github.AutoApprove.with"></a>',id:"with-",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.AutoApprove.with.parameter.mixins"></a>',id:"mixinsrequired-",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.AutoApprove.postProjectCreation"></a>',id:"postprojectcreation-",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.AutoApprove.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired-",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.AutoApprove.postSynthesize"></a>',id:"postsynthesize-",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.AutoApprove.preSynthesize"></a>',id:"presynthesize-",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.AutoApprove.projectCreation"></a>',id:"projectcreation-",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.AutoApprove.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--1",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.AutoApprove.synthesize"></a>',id:"synthesize-",level:5},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions-",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.AutoApprove.isConstruct"></a>',id:"isconstruct-",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.AutoApprove.isConstruct.parameter.x"></a>',id:"xrequired-",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.AutoApprove.isComponent"></a>',id:"iscomponent-",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.AutoApprove.isComponent.parameter.x"></a>',id:"xrequired--1",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties-",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.AutoApprove.property.node"></a>',id:"noderequired-",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.AutoApprove.property.project"></a>',id:"projectrequired-",level:5},{value:'<code>label</code><sup>Required</sup> <a name="label" id="projen.github.AutoApprove.property.label"></a>',id:"labelrequired-",level:5},{value:'AutoMerge <a name="AutoMerge" id="projen.github.AutoMerge"></a>',id:"automerge-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.AutoMerge.Initializer"></a>',id:"initializers--1",level:4},{value:'<code>github</code><sup>Required</sup> <a name="github" id="projen.github.AutoMerge.Initializer.parameter.github"></a>',id:"githubrequired--1",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.AutoMerge.Initializer.parameter.options"></a>',id:"optionsoptional--1",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--1",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.AutoMerge.toString"></a>',id:"tostring--1",level:5},{value:'<code>with</code> <a name="with" id="projen.github.AutoMerge.with"></a>',id:"with--1",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.AutoMerge.with.parameter.mixins"></a>',id:"mixinsrequired--1",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.AutoMerge.postProjectCreation"></a>',id:"postprojectcreation--1",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.AutoMerge.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--2",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.AutoMerge.postSynthesize"></a>',id:"postsynthesize--1",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.AutoMerge.preSynthesize"></a>',id:"presynthesize--1",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.AutoMerge.projectCreation"></a>',id:"projectcreation--1",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.AutoMerge.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--3",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.AutoMerge.synthesize"></a>',id:"synthesize--1",level:5},{value:'<code>addConditions</code> <a name="addConditions" id="projen.github.AutoMerge.addConditions"></a>',id:"addconditions-",level:5},{value:'<code>conditions</code><sup>Required</sup> <a name="conditions" id="projen.github.AutoMerge.addConditions.parameter.conditions"></a>',id:"conditionsrequired-",level:6},{value:'<code>addConditionsLater</code> <a name="addConditionsLater" id="projen.github.AutoMerge.addConditionsLater"></a>',id:"addconditionslater-",level:5},{value:'<code>later</code><sup>Required</sup> <a name="later" id="projen.github.AutoMerge.addConditionsLater.parameter.later"></a>',id:"laterrequired-",level:6},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--1",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.AutoMerge.isConstruct"></a>',id:"isconstruct--1",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.AutoMerge.isConstruct.parameter.x"></a>',id:"xrequired--2",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.AutoMerge.isComponent"></a>',id:"iscomponent--1",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.AutoMerge.isComponent.parameter.x"></a>',id:"xrequired--3",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--1",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.AutoMerge.property.node"></a>',id:"noderequired--1",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.AutoMerge.property.project"></a>',id:"projectrequired--1",level:5},{value:'AutoQueue <a name="AutoQueue" id="projen.github.AutoQueue"></a>',id:"autoqueue-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.AutoQueue.Initializer"></a>',id:"initializers--2",level:4},{value:'<code>scope</code><sup>Required</sup> <a name="scope" id="projen.github.AutoQueue.Initializer.parameter.scope"></a>',id:"scoperequired-",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.AutoQueue.Initializer.parameter.options"></a>',id:"optionsoptional--2",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--2",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.AutoQueue.toString"></a>',id:"tostring--2",level:5},{value:'<code>with</code> <a name="with" id="projen.github.AutoQueue.with"></a>',id:"with--2",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.AutoQueue.with.parameter.mixins"></a>',id:"mixinsrequired--2",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.AutoQueue.postProjectCreation"></a>',id:"postprojectcreation--2",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.AutoQueue.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--4",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.AutoQueue.postSynthesize"></a>',id:"postsynthesize--2",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.AutoQueue.preSynthesize"></a>',id:"presynthesize--2",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.AutoQueue.projectCreation"></a>',id:"projectcreation--2",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.AutoQueue.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--5",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.AutoQueue.synthesize"></a>',id:"synthesize--2",level:5},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--2",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.AutoQueue.isConstruct"></a>',id:"isconstruct--2",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.AutoQueue.isConstruct.parameter.x"></a>',id:"xrequired--4",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.AutoQueue.isComponent"></a>',id:"iscomponent--2",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.AutoQueue.isComponent.parameter.x"></a>',id:"xrequired--5",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--2",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.AutoQueue.property.node"></a>',id:"noderequired--2",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.AutoQueue.property.project"></a>',id:"projectrequired--2",level:5},{value:'Dependabot <a name="Dependabot" id="projen.github.Dependabot"></a>',id:"dependabot-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.Dependabot.Initializer"></a>',id:"initializers--3",level:4},{value:'<code>github</code><sup>Required</sup> <a name="github" id="projen.github.Dependabot.Initializer.parameter.github"></a>',id:"githubrequired--2",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.Dependabot.Initializer.parameter.options"></a>',id:"optionsoptional--3",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--3",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.Dependabot.toString"></a>',id:"tostring--3",level:5},{value:'<code>with</code> <a name="with" id="projen.github.Dependabot.with"></a>',id:"with--3",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.Dependabot.with.parameter.mixins"></a>',id:"mixinsrequired--3",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.Dependabot.postProjectCreation"></a>',id:"postprojectcreation--3",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.Dependabot.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--6",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.Dependabot.postSynthesize"></a>',id:"postsynthesize--3",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.Dependabot.preSynthesize"></a>',id:"presynthesize--3",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.Dependabot.projectCreation"></a>',id:"projectcreation--3",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.Dependabot.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--7",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.Dependabot.synthesize"></a>',id:"synthesize--3",level:5},{value:'<code>addAllow</code> <a name="addAllow" id="projen.github.Dependabot.addAllow"></a>',id:"addallow-",level:5},{value:'<code>dependencyName</code><sup>Required</sup> <a name="dependencyName" id="projen.github.Dependabot.addAllow.parameter.dependencyName"></a>',id:"dependencynamerequired-",level:6},{value:'<code>addIgnore</code> <a name="addIgnore" id="projen.github.Dependabot.addIgnore"></a>',id:"addignore-",level:5},{value:'<code>dependencyName</code><sup>Required</sup> <a name="dependencyName" id="projen.github.Dependabot.addIgnore.parameter.dependencyName"></a>',id:"dependencynamerequired--1",level:6},{value:'<code>versions</code><sup>Required</sup> <a name="versions" id="projen.github.Dependabot.addIgnore.parameter.versions"></a>',id:"versionsrequired-",level:6},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--3",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.Dependabot.isConstruct"></a>',id:"isconstruct--3",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.Dependabot.isConstruct.parameter.x"></a>',id:"xrequired--6",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.Dependabot.isComponent"></a>',id:"iscomponent--3",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.Dependabot.isComponent.parameter.x"></a>',id:"xrequired--7",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--3",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.Dependabot.property.node"></a>',id:"noderequired--3",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.Dependabot.property.project"></a>',id:"projectrequired--3",level:5},{value:'<code>config</code><sup>Required</sup> <a name="config" id="projen.github.Dependabot.property.config"></a>',id:"configrequired-",level:5},{value:'<code>ignoresProjen</code><sup>Required</sup> <a name="ignoresProjen" id="projen.github.Dependabot.property.ignoresProjen"></a>',id:"ignoresprojenrequired-",level:5},{value:'DependencyReview <a name="DependencyReview" id="projen.github.DependencyReview"></a>',id:"dependencyreview-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.DependencyReview.Initializer"></a>',id:"initializers--4",level:4},{value:'<code>github</code><sup>Required</sup> <a name="github" id="projen.github.DependencyReview.Initializer.parameter.github"></a>',id:"githubrequired--3",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.DependencyReview.Initializer.parameter.options"></a>',id:"optionsoptional--4",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--4",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.DependencyReview.toString"></a>',id:"tostring--4",level:5},{value:'<code>with</code> <a name="with" id="projen.github.DependencyReview.with"></a>',id:"with--4",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.DependencyReview.with.parameter.mixins"></a>',id:"mixinsrequired--4",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.DependencyReview.postProjectCreation"></a>',id:"postprojectcreation--4",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.DependencyReview.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--8",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.DependencyReview.postSynthesize"></a>',id:"postsynthesize--4",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.DependencyReview.preSynthesize"></a>',id:"presynthesize--4",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.DependencyReview.projectCreation"></a>',id:"projectcreation--4",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.DependencyReview.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--9",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.DependencyReview.synthesize"></a>',id:"synthesize--4",level:5},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--4",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.DependencyReview.isConstruct"></a>',id:"isconstruct--4",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.DependencyReview.isConstruct.parameter.x"></a>',id:"xrequired--8",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.DependencyReview.isComponent"></a>',id:"iscomponent--4",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.DependencyReview.isComponent.parameter.x"></a>',id:"xrequired--9",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--4",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.DependencyReview.property.node"></a>',id:"noderequired--4",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.DependencyReview.property.project"></a>',id:"projectrequired--4",level:5},{value:'GitHub <a name="GitHub" id="projen.github.GitHub"></a>',id:"github-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.GitHub.Initializer"></a>',id:"initializers--5",level:4},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.GitHub.Initializer.parameter.project"></a>',id:"projectrequired--5",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.GitHub.Initializer.parameter.options"></a>',id:"optionsoptional--5",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--5",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.GitHub.toString"></a>',id:"tostring--5",level:5},{value:'<code>with</code> <a name="with" id="projen.github.GitHub.with"></a>',id:"with--5",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.GitHub.with.parameter.mixins"></a>',id:"mixinsrequired--5",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.GitHub.postProjectCreation"></a>',id:"postprojectcreation--5",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.GitHub.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--10",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.GitHub.postSynthesize"></a>',id:"postsynthesize--5",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.GitHub.preSynthesize"></a>',id:"presynthesize--5",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.GitHub.projectCreation"></a>',id:"projectcreation--5",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.GitHub.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--11",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.GitHub.synthesize"></a>',id:"synthesize--5",level:5},{value:'<code>addDependabot</code> <a name="addDependabot" id="projen.github.GitHub.addDependabot"></a>',id:"adddependabot-",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.GitHub.addDependabot.parameter.options"></a>',id:"optionsoptional--6",level:6},{value:'<code>addPullRequestTemplate</code> <a name="addPullRequestTemplate" id="projen.github.GitHub.addPullRequestTemplate"></a>',id:"addpullrequesttemplate-",level:5},{value:'<code>content</code><sup>Required</sup> <a name="content" id="projen.github.GitHub.addPullRequestTemplate.parameter.content"></a>',id:"contentrequired-",level:6},{value:'<code>addWorkflow</code> <a name="addWorkflow" id="projen.github.GitHub.addWorkflow"></a>',id:"addworkflow-",level:5},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.GitHub.addWorkflow.parameter.name"></a>',id:"namerequired-",level:6},{value:'<code>runsOnConfig</code> <a name="runsOnConfig" id="projen.github.GitHub.runsOnConfig"></a>',id:"runsonconfig-",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.GitHub.runsOnConfig.parameter.options"></a>',id:"optionsoptional--7",level:6},{value:'<code>tryFindWorkflow</code> <a name="tryFindWorkflow" id="projen.github.GitHub.tryFindWorkflow"></a>',id:"tryfindworkflow-",level:5},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.GitHub.tryFindWorkflow.parameter.name"></a>',id:"namerequired--1",level:6},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--5",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.GitHub.isConstruct"></a>',id:"isconstruct--5",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.GitHub.isConstruct.parameter.x"></a>',id:"xrequired--10",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.GitHub.isComponent"></a>',id:"iscomponent--5",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.GitHub.isComponent.parameter.x"></a>',id:"xrequired--11",level:6},{value:'<code>of</code> <a name="of" id="projen.github.GitHub.of"></a>',id:"of-",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.GitHub.of.parameter.project"></a>',id:"projectrequired--6",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--5",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.GitHub.property.node"></a>',id:"noderequired--5",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.GitHub.property.project"></a>',id:"projectrequired--7",level:5},{value:'<code>actions</code><sup>Required</sup> <a name="actions" id="projen.github.GitHub.property.actions"></a>',id:"actionsrequired-",level:5},{value:'<code>checkoutSubmodules</code><sup>Required</sup> <a name="checkoutSubmodules" id="projen.github.GitHub.property.checkoutSubmodules"></a>',id:"checkoutsubmodulesrequired-",level:5},{value:'<code>downloadLfs</code><sup>Required</sup> <a name="downloadLfs" id="projen.github.GitHub.property.downloadLfs"></a>',id:"downloadlfsrequired-",level:5},{value:'<code>projenCredentials</code><sup>Required</sup> <a name="projenCredentials" id="projen.github.GitHub.property.projenCredentials"></a>',id:"projencredentialsrequired-",level:5},{value:'<code>workflows</code><sup>Required</sup> <a name="workflows" id="projen.github.GitHub.property.workflows"></a>',id:"workflowsrequired-",level:5},{value:'<code>workflowsEnabled</code><sup>Required</sup> <a name="workflowsEnabled" id="projen.github.GitHub.property.workflowsEnabled"></a>',id:"workflowsenabledrequired-",level:5},{value:'<code>mergeQueue</code><sup>Optional</sup> <a name="mergeQueue" id="projen.github.GitHub.property.mergeQueue"></a>',id:"mergequeueoptional-",level:5},{value:'<code>mergify</code><sup>Optional</sup> <a name="mergify" id="projen.github.GitHub.property.mergify"></a>',id:"mergifyoptional-",level:5},{value:'GitHubProject <a name="GitHubProject" id="projen.github.GitHubProject"></a>',id:"githubproject-",level:3}

1,{value:'Initializers <a name="Initializers" id="projen.github.GitHubProject.Initializer"></a>',id:"initializers--6",level:4},{value:'<code>options</code><sup>Required</sup> <a name="options" id="projen.github.GitHubProject.Initializer.parameter.options"></a>',id:"optionsrequired-",level:5},{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--6",level:4},{value:'<del><code>toString</code></del> <a name="toString" id="projen.github.GitHubProject.toString"></a>',id:"tostring--6",level:5},{value:'<del><code>with</code></del> <a name="with" id="projen.github.GitHubProject.with"></a>',id:"with--6",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.GitHubProject.with.parameter.mixins"></a>',id:"mixinsrequired--6",level:6},{value:'<del><code>addExcludeFromCleanup</code></del> <a name="addExcludeFromCleanup" id="projen.github.GitHubProject.addExcludeFromCleanup"></a>',id:"addexcludefromcleanup-",level:5},{value:'<code>globs</code><sup>Required</sup> <a name="globs" id="projen.github.GitHubProject.addExcludeFromCleanup.parameter.globs"></a>',id:"globsrequired-",level:6},{value:'<del><code>addGitIgnore</code></del> <a name="addGitIgnore" id="projen.github.GitHubProject.addGitIgnore"></a>',id:"addgitignore-",level:5},{value:'<code>pattern</code><sup>Required</sup> <a name="pattern" id="projen.github.GitHubProject.addGitIgnore.parameter.pattern"></a>',id:"patternrequired-",level:6},{value:'<del><code>addPackageIgnore</code></del> <a name="addPackageIgnore" id="projen.github.GitHubProject.addPackageIgnore"></a>',id:"addpackageignore-",level:5},{value:'<code>_pattern</code><sup>Required</sup> <a name="_pattern" id="projen.github.GitHubProject.addPackageIgnore.parameter._pattern"></a>',id:"_patternrequired-",level:6},{value:'<del><code>addTask</code></del> <a name="addTask" id="projen.github.GitHubProject.addTask"></a>',id:"addtask-",level:5},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.GitHubProject.addTask.parameter.name"></a>',id:"namerequired--2",level:6},{value:'<code>props</code><sup>Optional</sup> <a name="props" id="projen.github.GitHubProject.addTask.parameter.props"></a>',id:"propsoptional-",level:6},{value:'<del><code>annotateGenerated</code></del> <a name="annotateGenerated" id="projen.github.GitHubProject.annotateGenerated"></a>',id:"annotategenerated-",level:5},{value:'<code>glob</code><sup>Required</sup> <a name="glob" id="projen.github.GitHubProject.annotateGenerated.parameter.glob"></a>',id:"globrequired-",level:6},{value:'<del><code>postSynthesize</code></del> <a name="postSynthesize" id="projen.github.GitHubProject.postSynthesize"></a>',id:"postsynthesize--6",level:5},{value:'<del><code>preSynthesize</code></del> <a name="preSynthesize" id="projen.github.GitHubProject.preSynthesize"></a>',id:"presynthesize--6",level:5},{value:'<del><code>removeTask</code></del> <a name="removeTask" id="projen.github.GitHubProject.removeTask"></a>',id:"removetask-",level:5},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.GitHubProject.removeTask.parameter.name"></a>',id:"namerequired--3",level:6},{value:'<del><code>runTaskCommand</code></del> <a name="runTaskCommand" id="projen.github.GitHubProject.runTaskCommand"></a>',id:"runtaskcommand-",level:5},{value:'<code>task</code><sup>Required</sup> <a name="task" id="projen.github.GitHubProject.runTaskCommand.parameter.task"></a>',id:"taskrequired-",level:6},{value:'<del><code>synth</code></del> <a name="synth" id="projen.github.GitHubProject.synth"></a>',id:"synth-",level:5},{value:'<del><code>tryFindFile</code></del> <a name="tryFindFile" id="projen.github.GitHubProject.tryFindFile"></a>',id:"tryfindfile-",level:5},{value:'<code>filePath</code><sup>Required</sup> <a name="filePath" id="projen.github.GitHubProject.tryFindFile.parameter.filePath"></a>',id:"filepathrequired-",level:6},{value:'<del><code>tryFindObjectFile</code></del> <a name="tryFindObjectFile" id="projen.github.GitHubProject.tryFindObjectFile"></a>',id:"tryfindobjectfile-",level:5},{value:'<code>filePath</code><sup>Required</sup> <a name="filePath" id="projen.github.GitHubProject.tryFindObjectFile.parameter.filePath"></a>',id:"filepathrequired--1",level:6},{value:'<del><code>tryRemoveFile</code></del> <a name="tryRemoveFile" id="projen.github.GitHubProject.tryRemoveFile"></a>',id:"tryremovefile-",level:5},{value:'<code>filePath</code><sup>Required</sup> <a name="filePath" id="projen.github.GitHubProject.tryRemoveFile.parameter.filePath"></a>',id:"filepathrequired--2",level:6},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--6",level:4},{value:'<del><code>isConstruct</code></del> <a name="isConstruct" id="projen.github.GitHubProject.isConstruct"></a>',id:"isconstruct--6",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.GitHubProject.isConstruct.parameter.x"></a>',id:"xrequired--12",level:6},{value:'<del><code>isProject</code></del> <a name="isProject" id="projen.github.GitHubProject.isProject"></a>',id:"isproject-",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.GitHubProject.isProject.parameter.x"></a>',id:"xrequired--13",level:6},{value:'<del><code>of</code></del> <a name="of" id="projen.github.GitHubProject.of"></a>',id:"of--1",level:5},{value:'<code>construct</code><sup>Required</sup> <a name="construct" id="projen.github.GitHubProject.of.parameter.construct"></a>',id:"constructrequired-",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--6",level:4},{value:'<del><code>node</code></del><sup>Required</sup> <a name="node" id="projen.github.GitHubProject.property.node"></a>',id:"noderequired--6",level:5},{value:'<del><code>buildTask</code></del><sup>Required</sup> <a name="buildTask" id="projen.github.GitHubProject.property.buildTask"></a>',id:"buildtaskrequired-",level:5},{value:'<del><code>commitGenerated</code></del><sup>Required</sup> <a name="commitGenerated" id="projen.github.GitHubProject.property.commitGenerated"></a>',id:"commitgeneratedrequired-",level:5},{value:'<del><code>compileTask</code></del><sup>Required</sup> <a name="compileTask" id="projen.github.GitHubProject.property.compileTask"></a>',id:"compiletaskrequired-",level:5},{value:'<del><code>components</code></del><sup>Required</sup> <a name="components" id="projen.github.GitHubProject.property.components"></a>',id:"componentsrequired-",level:5},{value:'<del><code>deps</code></del><sup>Required</sup> <a name="deps" id="projen.github.GitHubProject.property.deps"></a>',id:"depsrequired-",level:5},{value:'<del><code>ejected</code></del><sup>Required</sup> <a name="ejected" id="projen.github.GitHubProject.property.ejected"></a>',id:"ejectedrequired-",level:5},{value:'<del><code>files</code></del><sup>Required</sup> <a name="files" id="projen.github.GitHubProject.property.files"></a>',id:"filesrequired-",level:5},{value:'<del><code>gitattributes</code></del><sup>Required</sup> <a name="gitattributes" id="projen.github.GitHubProject.property.gitattributes"></a>',id:"gitattributesrequired-",level:5},{value:'<del><code>gitignore</code></del><sup>Required</sup> <a name="gitignore" id="projen.github.GitHubProject.property.gitignore"></a>',id:"gitignorerequired-",level:5},{value:'<del><code>logger</code></del><sup>Required</sup> <a name="logger" id="projen.github.GitHubProject.property.logger"></a>',id:"loggerrequired-",level:5},{value:'<del><code>name</code></del><sup>Required</sup> <a name="name" id="projen.github.GitHubProject.property.name"></a>',id:"namerequired--4",level:5},{value:'<del><code>outdir</code></del><sup>Required</sup> <a name="outdir" id="projen.github.GitHubProject.property.outdir"></a>',id:"outdirrequired-",level:5},{value:'<del><code>packageTask</code></del><sup>Required</sup> <a name="packageTask" id="projen.github.GitHubProject.property.packageTask"></a>',id:"packagetaskrequired-",level:5},{value:'<del><code>postCompileTask</code></del><sup>Required</sup> <a name="postCompileTask" id="projen.github.GitHubProject.property.postCompileTask"></a>',id:"postcompiletaskrequired-",level:5},{value:'<del><code>preCompileTask</code></del><sup>Required</sup> <a name="preCompileTask" id="projen.github.GitHubProject.property.preCompileTask"></a>',id:"precompiletaskrequired-",level:5},{value:'<del><code>projectBuild</code></del><sup>Required</sup> <a name="projectBuild" id="projen.github.GitHubProject.property.projectBuild"></a>',id:"projectbuildrequired-",level:5},{value:'<del><code>projenCommand</code></del><sup>Required</sup> <a name="projenCommand" id="projen.github.GitHubProject.property.projenCommand"></a>',id:"projencommandrequired-",level:5},{value:'<del><code>root</code></del><sup>Required</sup> <a name="root" id="projen.github.GitHubProject.property.root"></a>',id:"rootrequired-",level:5},{value:'<del><code>subprojects</code></del><sup>Required</sup> <a name="subprojects" id="projen.github.GitHubProject.property.subprojects"></a>',id:"subprojectsrequired-",level:5},{value:'<del><code>tasks</code></del><sup>Required</sup> <a name="tasks" id="projen.github.GitHubProject.property.tasks"></a>',id:"tasksrequired-",level:5},{value:'<del><code>testTask</code></del><sup>Required</sup> <a name="testTask" id="projen.github.GitHubProject.property.testTask"></a>',id:"testtaskrequired-",level:5},{value:'<del><code>defaultTask</code></del><sup>Optional</sup> <a name="defaultTask" id="projen.github.GitHubProject.property.defaultTask"></a>',id:"defaulttaskoptional-",level:5},{value:'<del><code>initProject</code></del><sup>Optional</sup> <a name="initProject" id="projen.github.GitHubProject.property.initProject"></a>',id:"initprojectoptional-",level:5},{value:'<del><code>parent</code></del><sup>Optional</sup> <a name="parent" id="projen.github.GitHubProject.property.parent"></a>',id:"parentoptional-",level:5},{value:'<del><code>autoApprove</code></del><sup>Optional</sup> <a name="autoApprove" id="projen.github.GitHubProject.property.autoApprove"></a>',id:"autoapproveoptional-",level:5},{value:'<del><code>devContainer</code></del><sup>Optional</sup> <a name="devContainer" id="projen.github.GitHubProject.property.devContainer"></a>',id:"devcontaineroptional-",level:5},{value:'<del><code>github</code></del><sup>Optional</sup> <a name="github" id="projen.github.GitHubProject.property.github"></a>',id:"githuboptional-",level:5},{value:'<del><code>gitpod</code></del><sup>Optional</sup> <a name="gitpod" id="projen.github.GitHubProject.property.gitpod"></a>',id:"gitpodoptional-",level:5},{value:'<del><code>vscode</code></del><sup>Optional</sup> <a name="vscode" id="projen.github.GitHubProject.property.vscode"></a>',id:"vscodeoptional-",level:5}

1,{value:'Constants <a name="Constants" id="Constants"></a>',id:"constants-",level:4},{value:'<del><code>DEFAULT_TASK</code></del><sup>Required</sup> <a name="DEFAULT_TASK" id="projen.github.GitHubProject.property.DEFAULT_TASK"></a>',id:"default_taskrequired-",level:5},{value:'GithubWorkflow <a name="GithubWorkflow" id="projen.github.GithubWorkflow"></a>',id:"githubworkflow-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.GithubWorkflow.Initializer"></a>',id:"initializers--7",level:4},{value:'<code>github</code><sup>Required</sup> <a name="github" id="projen.github.GithubWorkflow.Initializer.parameter.github"></a>',id:"githubrequired--4",level:5},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.GithubWorkflow.Initializer.parameter.name"></a>',id:"namerequired--5",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.GithubWorkflow.Initializer.parameter.options"></a>',id:"optionsoptional--8",level:5},{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--7",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.GithubWorkflow.toString"></a>',id:"tostring--7",level:5},{value:'<code>with</code> <a name="with" id="projen.github.GithubWorkflow.with"></a>',id:"with--7",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.GithubWorkflow.with.parameter.mixins"></a>',id:"mixinsrequired--7",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.GithubWorkflow.postProjectCreation"></a>',id:"postprojectcreation--6",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.GithubWorkflow.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--12",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.GithubWorkflow.postSynthesize"></a>',id:"postsynthesize--7",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.GithubWorkflow.preSynthesize"></a>',id:"presynthesize--7",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.GithubWorkflow.projectCreation"></a>',id:"projectcreation--6",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.GithubWorkflow.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--13",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.GithubWorkflow.synthesize"></a>',id:"synthesize--6",level:5},{value:'<code>addJob</code> <a name="addJob" id="projen.github.GithubWorkflow.addJob"></a>',id:"addjob-",level:5},{value:'<code>id</code><sup>Required</sup> <a name="id" id="projen.github.GithubWorkflow.addJob.parameter.id"></a>',id:"idrequired-",level:6},{value:'<code>job</code><sup>Required</sup> <a name="job" id="projen.github.GithubWorkflow.addJob.parameter.job"></a>',id:"jobrequired-",level:6},{value:'<code>addJobs</code> <a name="addJobs" id="projen.github.GithubWorkflow.addJobs"></a>',id:"addjobs-",level:5},{value:'<code>jobs</code><sup>Required</sup> <a name="jobs" id="projen.github.GithubWorkflow.addJobs.parameter.jobs"></a>',id:"jobsrequired-",level:6},{value:'<code>appendStep</code> <a name="appendStep" id="projen.github.GithubWorkflow.appendStep"></a>',id:"appendstep-",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.GithubWorkflow.appendStep.parameter.jobId"></a>',id:"jobidrequired-",level:6},{value:'<code>step</code><sup>Required</sup> <a name="step" id="projen.github.GithubWorkflow.appendStep.parameter.step"></a>',id:"steprequired-",level:6},{value:'<code>getJob</code> <a name="getJob" id="projen.github.GithubWorkflow.getJob"></a>',id:"getjob-",level:5},{value:'<code>id</code><sup>Required</sup> <a name="id" id="projen.github.GithubWorkflow.getJob.parameter.id"></a>',id:"idrequired--1",level:6},{value:'<code>getStep</code> <a name="getStep" id="projen.github.GithubWorkflow.getStep"></a>',id:"getstep-",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.GithubWorkflow.getStep.parameter.jobId"></a>',id:"jobidrequired--1",level:6},{value:'<code>stepId</code><sup>Required</sup> <a name="stepId" id="projen.github.GithubWorkflow.getStep.parameter.stepId"></a>',id:"stepidrequired-",level:6},{value:'<code>insertStepAfter</code> <a name="insertStepAfter" id="projen.github.GithubWorkflow.insertStepAfter"></a>',id:"insertstepafter-",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.GithubWorkflow.insertStepAfter.parameter.jobId"></a>',id:"jobidrequired--2",level:6},{value:'<code>referenceStepId</code><sup>Required</sup> <a name="referenceStepId" id="projen.github.GithubWorkflow.insertStepAfter.parameter.referenceStepId"></a>',id:"referencestepidrequired-",level:6},{value:'<code>step</code><sup>Required</sup> <a name="step" id="projen.github.GithubWorkflow.insertStepAfter.parameter.step"></a>',id:"steprequired--1",level:6},{value:'<code>insertStepBefore</code> <a name="insertStepBefore" id="projen.github.GithubWorkflow.insertStepBefore"></a>',id:"insertstepbefore-",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.GithubWorkflow.insertStepBefore.parameter.jobId"></a>',id:"jobidrequired--3",level:6},{value:'<code>referenceStepId</code><sup>Required</sup> <a name="referenceStepId" id="projen.github.GithubWorkflow.insertStepBefore.parameter.referenceStepId"></a>',id:"referencestepidrequired--1",level:6},{value:'<code>step</code><sup>Required</sup> <a name="step" id="projen.github.GithubWorkflow.insertStepBefore.parameter.step"></a>',id:"steprequired--2",level:6},{value:'<code>on</code> <a name="on" id="projen.github.GithubWorkflow.on"></a>',id:"on-",level:5},{value:'<code>events</code><sup>Required</sup> <a name="events" id="projen.github.GithubWorkflow.on.parameter.events"></a>',id:"eventsrequired-",level:6},{value:'<code>patchStep</code> <a name="patchStep" id="projen.github.GithubWorkflow.patchStep"></a>',id:"patchstep-",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.GithubWorkflow.patchStep.parameter.jobId"></a>',id:"jobidrequired--4",level:6},{value:'<code>stepId</code><sup>Required</sup> <a name="stepId" id="projen.github.GithubWorkflow.patchStep.parameter.stepId"></a>',id:"stepidrequired--1",level:6},{value:'<code>patch</code><sup>Required</sup> <a name="patch" id="projen.github.GithubWorkflow.patchStep.parameter.patch"></a>',id:"patchrequired-",level:6},{value:'<code>removeJob</code> <a name="removeJob" id="projen.github.GithubWorkflow.removeJob"></a>',id:"removejob-",level:5},{value:'<code>id</code><sup>Required</sup> <a name="id" id="projen.github.GithubWorkflow.removeJob.parameter.id"></a>',id:"idrequired--2",level:6},{value:'<code>removeStep</code> <a name="removeStep" id="projen.github.GithubWorkflow.removeStep"></a>',id:"removestep-",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.GithubWorkflow.removeStep.parameter.jobId"></a>',id:"jobidrequired--5",level:6},{value:'<code>stepId</code><sup>Required</sup> <a name="stepId" id="projen.github.GithubWorkflow.removeStep.parameter.stepId"></a>',id:"stepidrequired--2",level:6},{value:'<code>replaceStep</code> <a name="replaceStep" id="projen.github.GithubWorkflow.replaceStep"></a>',id:"replacestep-",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.GithubWorkflow.replaceStep.parameter.jobId"></a>',id:"jobidrequired--6",level:6},{value:'<code>stepId</code><sup>Required</sup> <a name="stepId" id="projen.github.GithubWorkflow.replaceStep.parameter.stepId"></a>',id:"stepidrequired--3",level:6},{value:'<code>replacementStep</code><sup>Required</sup> <a name="replacementStep" id="projen.github.GithubWorkflow.replaceStep.parameter.replacementStep"></a>',id:"replacementsteprequired-",level:6},{value:'<code>updateJob</code> <a name="updateJob" id="projen.github.GithubWorkflow.updateJob"></a>',id:"updatejob-",level:5},{value:'<code>id</code><sup>Required</sup> <a name="id" id="projen.github.GithubWorkflow.updateJob.parameter.id"></a>',id:"idrequired--3",level:6},{value:'<code>job</code><sup>Required</sup> <a name="job" id="projen.github.GithubWorkflow.updateJob.parameter.job"></a>',id:"jobrequired--1",level:6},{value:'<code>updateJobs</code> <a name="updateJobs" id="projen.github.GithubWorkflow.updateJobs"></a>',id:"updatejobs-",level:5},{value:'<code>jobs</code><sup>Required</sup> <a name="jobs" id="projen.github.GithubWorkflow.updateJobs.parameter.jobs"></a>',id:"jobsrequired--1",level:6},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--7",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.GithubWorkflow.isConstruct"></a>',id:"isconstruct--7",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.GithubWorkflow.isConstruct.parameter.x"></a>',id:"xrequired--14",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.GithubWorkflow.isComponent"></a>',id:"iscomponent--6",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.GithubWorkflow.isComponent.parameter.x"></a>',id:"xrequired--15",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--7",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.GithubWorkflow.property.node"></a>',id:"noderequired--7",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.GithubWorkflow.property.project"></a>',id:"projectrequired--8",level:5},{value:'<code>jobs</code><sup>Required</sup> <a name="jobs" id="projen.github.GithubWorkflow.property.jobs"></a>',id:"jobsrequired--2",level:5},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.GithubWorkflow.property.name"></a>',id:"namerequired--6",level:5},{value:'<code>projenCredentials</code><sup>Required</sup> <a name="projenCredentials" id="projen.github.GithubWorkflow.property.projenCredentials"></a>',id:"projencredentialsrequired--1",level:5},{value:'<code>concurrency</code><sup>Optional</sup> <a name="concurrency" id="projen.github.GithubWorkflow.property.concurrency"></a>',id:"concurrencyoptional-",level:5},{value:'<code>env</code><sup>Optional</sup> <a name="env" id="projen.github.GithubWorkflow.property.env"></a>',id:"envoptional-",level:5},{value:'<code>file</code><sup>Optional</sup> <a name="file" id="projen.github.GithubWorkflow.property.file"></a>',id:"fileoptional-",level:5},{value:'<code>runName</code><sup>Optional</sup> <a name="runName" id="projen.github.GithubWorkflow.property.runName"></a>',id:"runnameoptional-",level:5},{value:'MergeQueue <a name="MergeQueue" id="projen.github.MergeQueue"></a>',id:"mergequeue-",level:3}

1,{value:'Initializers <a name="Initializers" id="projen.github.MergeQueue.Initializer"></a>',id:"initializers--8",level:4},{value:'<code>scope</code><sup>Required</sup> <a name="scope" id="projen.github.MergeQueue.Initializer.parameter.scope"></a>',id:"scoperequired--1",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.MergeQueue.Initializer.parameter.options"></a>',id:"optionsoptional--9",level:5},{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--8",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.MergeQueue.toString"></a>',id:"tostring--8",level:5},{value:'<code>with</code> <a name="with" id="projen.github.MergeQueue.with"></a>',id:"with--8",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.MergeQueue.with.parameter.mixins"></a>',id:"mixinsrequired--8",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.MergeQueue.postProjectCreation"></a>',id:"postprojectcreation--7",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.MergeQueue.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--14",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.MergeQueue.postSynthesize"></a>',id:"postsynthesize--8",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.MergeQueue.preSynthesize"></a>',id:"presynthesize--8",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.MergeQueue.projectCreation"></a>',id:"projectcreation--7",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.MergeQueue.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--15",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.MergeQueue.synthesize"></a>',id:"synthesize--7",level:5},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--8",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.MergeQueue.isConstruct"></a>',id:"isconstruct--8",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.MergeQueue.isConstruct.parameter.x"></a>',id:"xrequired--16",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.MergeQueue.isComponent"></a>',id:"iscomponent--7",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.MergeQueue.isComponent.parameter.x"></a>',id:"xrequired--17",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--8",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.MergeQueue.property.node"></a>',id:"noderequired--8",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.MergeQueue.property.project"></a>',id:"projectrequired--9",level:5},{value:'Mergify <a name="Mergify" id="projen.github.Mergify"></a>',id:"mergify-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.Mergify.Initializer"></a>',id:"initializers--9",level:4},{value:'<code>github</code><sup>Required</sup> <a name="github" id="projen.github.Mergify.Initializer.parameter.github"></a>',id:"githubrequired--5",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.Mergify.Initializer.parameter.options"></a>',id:"optionsoptional--10",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--9",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.Mergify.toString"></a>',id:"tostring--9",level:5},{value:'<code>with</code> <a name="with" id="projen.github.Mergify.with"></a>',id:"with--9",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.Mergify.with.parameter.mixins"></a>',id:"mixinsrequired--9",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.Mergify.postProjectCreation"></a>',id:"postprojectcreation--8",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.Mergify.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--16",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.Mergify.postSynthesize"></a>',id:"postsynthesize--9",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.Mergify.preSynthesize"></a>',id:"presynthesize--9",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.Mergify.projectCreation"></a>',id:"projectcreation--8",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.Mergify.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--17",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.Mergify.synthesize"></a>',id:"synthesize--8",level:5},{value:'<code>addQueue</code> <a name="addQueue" id="projen.github.Mergify.addQueue"></a>',id:"addqueue-",level:5},{value:'<code>queue</code><sup>Required</sup> <a name="queue" id="projen.github.Mergify.addQueue.parameter.queue"></a>',id:"queuerequired-",level:6},{value:'<code>addRule</code> <a name="addRule" id="projen.github.Mergify.addRule"></a>',id:"addrule-",level:5},{value:'<code>rule</code><sup>Required</sup> <a name="rule" id="projen.github.Mergify.addRule.parameter.rule"></a>',id:"rulerequired-",level:6},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--9",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.Mergify.isConstruct"></a>',id:"isconstruct--9",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.Mergify.isConstruct.parameter.x"></a>',id:"xrequired--18",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.Mergify.isComponent"></a>',id:"iscomponent--8",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.Mergify.isComponent.parameter.x"></a>',id:"xrequired--19",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--9",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.Mergify.property.node"></a>',id:"noderequired--9",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.Mergify.property.project"></a>',id:"projectrequired--10",level:5},{value:'PullRequestBackport <a name="PullRequestBackport" id="projen.github.PullRequestBackport"></a>',id:"pullrequestbackport-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.PullRequestBackport.Initializer"></a>',id:"initializers--10",level:4},{value:'<code>scope</code><sup>Required</sup> <a name="scope" id="projen.github.PullRequestBackport.Initializer.parameter.scope"></a>',id:"scoperequired--2",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.PullRequestBackport.Initializer.parameter.options"></a>',id:"optionsoptional--11",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--10",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.PullRequestBackport.toString"></a>',id:"tostring--10",level:5},{value:'<code>with</code> <a name="with" id="projen.github.PullRequestBackport.with"></a>',id:"with--10",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.PullRequestBackport.with.parameter.mixins"></a>',id:"mixinsrequired--10",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.PullRequestBackport.postProjectCreation"></a>',id:"postprojectcreation--9",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.PullRequestBackport.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--18",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.PullRequestBackport.postSynthesize"></a>',id:"postsynthesize--10",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.PullRequestBackport.preSynthesize"></a>',id:"presynthesize--10",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.PullRequestBackport.projectCreation"></a>',id:"projectcreation--9",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.PullRequestBackport.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--19",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.PullRequestBackport.synthesize"></a>',id:"synthesize--9",level:5},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--10",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.PullRequestBackport.isConstruct"></a>',id:"isconstruct--10",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.PullRequestBackport.isConstruct.parameter.x"></a>',id:"xrequired--20",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.PullRequestBackport.isComponent"></a>',id:"iscomponent--9",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.PullRequestBackport.isComponent.parameter.x"></a>',id:"xrequired--21",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--10",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.PullRequestBackport.property.node"></a>',id:"noderequired--10",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.PullRequestBackport.property.project"></a>',id:"projectrequired--11",level:5},{value:'<code>file</code><sup>Required</sup> <a name="file" id="projen.github.PullRequestBackport.property.file"></a>',id:"filerequired-",level:5},{value:'<code>workflow</code><sup>Required</sup> <a name="workflow" id="projen.github.PullRequestBackport.property.workflow"></a>',id:"workflowrequired-",level:5},{value:'PullRequestLint <a name="PullRequestLint" id="projen.github.PullRequestLint"></a>',id:"pullrequestlint-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.PullRequestLint.Initializer"></a>',id:"initializers--11",level:4},{value:'<code>github</code><sup>Required</sup> <a name="github" id="projen.github.PullRequestLint.Initializer.parameter.github"></a>',id:"githubrequired--6",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.PullRequestLint.Initializer.parameter.options"></a>',id:"optionsoptional--12",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--11",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.PullRequestLint.toString"></a>',id:"tostring--11",level:5},{value:'<code>with</code> <a name="with" id="projen.github.PullRequestLint.with"></a>',id:"with--11",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.PullRequestLint.with.parameter.mixins"></a>',id:"mixinsrequired--11",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.PullRequestLint.postProjectCreation"></a>',id:"postprojectcreation--10",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.PullRequestLint.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--20",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.PullRequestLint.postSynthesize"></a>',id:"postsynthesize--11",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.PullRequestLint.preSynthesize"></a>',id:"presynthesize--11",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.PullRequestLint.projectCreation"></a>',id:"projectcreation--10",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.PullRequestLint.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--21",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.PullRequestLint.synthesize"></a>',id:"synthesize--10",level:5},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--11",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.PullRequestLint.isConstruct"></a>',id:"isconstruct--11",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.PullRequestLint.isConstruct.parameter.x"></a>',id:"xrequired--22",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.PullRequestLint.isComponent"></a>',id:"iscomponent--10",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.PullRequestLint.isComponent.parameter.x"></a>',id:"xrequired--23",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--11",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.PullRequestLint.property.node"></a>',id:"noderequired--11",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.PullRequestLint.property.project"></a>',id:"projectrequired--12",level:5},{value:'PullRequestTemplate <a name="PullRequestTemplate" id="projen.github.PullRequestTemplate"></a>',id:"pullrequesttemplate-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.PullRequestTemplate.Initializer"></a>',id:"initializers--12",level:4},{value:'<code>github</code><sup>Required</sup> <a name="github" id="projen.github.PullRequestTemplate.Initializer.parameter.github"></a>',id:"githubrequired--7",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.PullRequestTemplate.Initializer.parameter.options"></a>',id:"optionsoptional--13",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--12",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.PullRequestTemplate.toString"></a>',id:"tostring--12",level:5},{value:'<code>with</code> <a name="with" id="projen.github.PullRequestTemplate.with"></a>',id:"with--12",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.PullRequestTemplate.with.parameter.mixins"></a>',id:"mixinsrequired--12",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.PullRequestTemplate.postProjectCreation"></a>',id:"postprojectcreation--11",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.PullRequestTemplate.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--22",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.PullRequestTemplate.postSynthesize"></a>',id:"postsynthesize--12",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.PullRequestTemplate.preSynthesize"></a>',id:"presynthesize--12",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.PullRequestTemplate.projectCreation"></a>',id:"projectcreation--11",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.PullRequestTemplate.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--23",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.PullRequestTemplate.synthesize"></a>',id:"synthesize--11",level:5},{value:'<code>diff</code> <a name="diff" id="projen.github.PullRequestTemplate.diff"></a>',id:"diff-",level:5},{value:'<code>colorize</code><sup>Optional</sup> <a name="colorize" id="projen.github.PullRequestTemplate.diff.parameter.colorize"></a>',id:"colorizeoptional-",level:6},{value:'<code>contextLines</code><sup>Optional</sup> <a name="contextLines" id="projen.github.PullRequestTemplate.diff.parameter.contextLines"></a>',id:"contextlinesoptional-",level:6},{value:'<code>addLine</code> <a name="addLine" id="projen.github.PullRequestTemplate.addLine"></a>',id:"addline-",level:5},{value:'<code>line</code><sup>Required</sup> <a name="line" id="projen.github.PullRequestTemplate.addLine.parameter.line"></a>',id:"linerequired-",level:6},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--12",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.PullRequestTemplate.isConstruct"></a>',id:"isconstruct--12",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.PullRequestTemplate.isConstruct.parameter.x"></a>',id:"xrequired--24",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.PullRequestTemplate.isComponent"></a>',id:"iscomponent--11",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.PullRequestTemplate.isComponent.parameter.x"></a>',id:"xrequired--25",level:6},{value:'<code>of</code> <a name="of" id="projen.github.PullRequestTemplate.of"></a>',id:"of--2",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.PullRequestTemplate.of.parameter.project"></a>',id:"projectrequired--13",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--12",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.PullRequestTemplate.property.node"></a>',id:"noderequired--12",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.PullRequestTemplate.property.project"></a>',id:"projectrequired--14",level:5},{value:'<code>absolutePath</code><sup>Required</sup> <a name="absolutePath" id="projen.github.PullRequestTemplate.property.absolutePath"></a>',id:"absolutepathrequired-",level:5},{value:'<code>committed</code><sup>Required</sup> <a name="committed" id="projen.github.PullRequestTemplate.property.committed"></a>',id:"committedrequired-",level:5},{value:'<code>path</code><sup>Required</sup> <a name="path" id="projen.github.PullRequestTemplate.property.path"></a>',id:"pathrequired-",level:5},{value:'<code>changed</code><sup>Optional</sup> <a name="changed" id="projen.github.PullRequestTemplate.property.changed"></a>',id:"changedoptional-",level:5},{value:'<code>marker</code><sup>Optional</sup> <a name="marker" id="projen.github.PullRequestTemplate.property.marker"></a>',id:"markeroptional-",level:5},{value:'<code>executable</code><sup>Required</sup> <a name="executable" id="projen.github.PullRequestTemplate.property.executable"></a>',id:"executablerequired-",level:5},{value:'<code>readonly</code><sup>Required</sup> <a name="readonly" id="projen.github.PullRequestTemplate.property.readonly"></a>',id:"readonlyrequired-",level:5},{value:'Stale <a name="Stale" id="projen.github.Stale"></a>',id:"stale-",level:3}

1,{value:'Initializers <a name="Initializers" id="projen.github.Stale.Initializer"></a>',id:"initializers--13",level:4},{value:'<code>github</code><sup>Required</sup> <a name="github" id="projen.github.Stale.Initializer.parameter.github"></a>',id:"githubrequired--8",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.Stale.Initializer.parameter.options"></a>',id:"optionsoptional--14",level:5},{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--13",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.Stale.toString"></a>',id:"tostring--13",level:5},{value:'<code>with</code> <a name="with" id="projen.github.Stale.with"></a>',id:"with--13",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.Stale.with.parameter.mixins"></a>',id:"mixinsrequired--13",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.Stale.postProjectCreation"></a>',id:"postprojectcreation--12",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.Stale.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--24",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.Stale.postSynthesize"></a>',id:"postsynthesize--13",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.Stale.preSynthesize"></a>',id:"presynthesize--13",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.Stale.projectCreation"></a>',id:"projectcreation--12",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.Stale.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--25",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.Stale.synthesize"></a>',id:"synthesize--12",level:5},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--13",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.Stale.isConstruct"></a>',id:"isconstruct--13",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.Stale.isConstruct.parameter.x"></a>',id:"xrequired--26",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.Stale.isComponent"></a>',id:"iscomponent--12",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.Stale.isComponent.parameter.x"></a>',id:"xrequired--27",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--13",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.Stale.property.node"></a>',id:"noderequired--13",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.Stale.property.project"></a>',id:"projectrequired--15",level:5},{value:'TaskWorkflow <a name="TaskWorkflow" id="projen.github.TaskWorkflow"></a>',id:"taskworkflow-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.TaskWorkflow.Initializer"></a>',id:"initializers--14",level:4},{value:'<code>github</code><sup>Required</sup> <a name="github" id="projen.github.TaskWorkflow.Initializer.parameter.github"></a>',id:"githubrequired--9",level:5},{value:'<code>options</code><sup>Required</sup> <a name="options" id="projen.github.TaskWorkflow.Initializer.parameter.options"></a>',id:"optionsrequired--1",level:5}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--14",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.TaskWorkflow.toString"></a>',id:"tostring--14",level:5},{value:'<code>with</code> <a name="with" id="projen.github.TaskWorkflow.with"></a>',id:"with--14",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.TaskWorkflow.with.parameter.mixins"></a>',id:"mixinsrequired--14",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.TaskWorkflow.postProjectCreation"></a>',id:"postprojectcreation--13",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.TaskWorkflow.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--26",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.TaskWorkflow.postSynthesize"></a>',id:"postsynthesize--14",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.TaskWorkflow.preSynthesize"></a>',id:"presynthesize--14",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.TaskWorkflow.projectCreation"></a>',id:"projectcreation--13",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.TaskWorkflow.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--27",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.TaskWorkflow.synthesize"></a>',id:"synthesize--13",level:5},{value:'<code>addJob</code> <a name="addJob" id="projen.github.TaskWorkflow.addJob"></a>',id:"addjob--1",level:5},{value:'<code>id</code><sup>Required</sup> <a name="id" id="projen.github.TaskWorkflow.addJob.parameter.id"></a>',id:"idrequired--4",level:6},{value:'<code>job</code><sup>Required</sup> <a name="job" id="projen.github.TaskWorkflow.addJob.parameter.job"></a>',id:"jobrequired--2",level:6},{value:'<code>addJobs</code> <a name="addJobs" id="projen.github.TaskWorkflow.addJobs"></a>',id:"addjobs--1",level:5},{value:'<code>jobs</code><sup>Required</sup> <a name="jobs" id="projen.github.TaskWorkflow.addJobs.parameter.jobs"></a>',id:"jobsrequired--3",level:6},{value:'<code>appendStep</code> <a name="appendStep" id="projen.github.TaskWorkflow.appendStep"></a>',id:"appendstep--1",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.TaskWorkflow.appendStep.parameter.jobId"></a>',id:"jobidrequired--7",level:6},{value:'<code>step</code><sup>Required</sup> <a name="step" id="projen.github.TaskWorkflow.appendStep.parameter.step"></a>',id:"steprequired--3",level:6},{value:'<code>getJob</code> <a name="getJob" id="projen.github.TaskWorkflow.getJob"></a>',id:"getjob--1",level:5},{value:'<code>id</code><sup>Required</sup> <a name="id" id="projen.github.TaskWorkflow.getJob.parameter.id"></a>',id:"idrequired--5",level:6},{value:'<code>getStep</code> <a name="getStep" id="projen.github.TaskWorkflow.getStep"></a>',id:"getstep--1",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.TaskWorkflow.getStep.parameter.jobId"></a>',id:"jobidrequired--8",level:6},{value:'<code>stepId</code><sup>Required</sup> <a name="stepId" id="projen.github.TaskWorkflow.getStep.parameter.stepId"></a>',id:"stepidrequired--4",level:6},{value:'<code>insertStepAfter</code> <a name="insertStepAfter" id="projen.github.TaskWorkflow.insertStepAfter"></a>',id:"insertstepafter--1",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.TaskWorkflow.insertStepAfter.parameter.jobId"></a>',id:"jobidrequired--9",level:6},{value:'<code>referenceStepId</code><sup>Required</sup> <a name="referenceStepId" id="projen.github.TaskWorkflow.insertStepAfter.parameter.referenceStepId"></a>',id:"referencestepidrequired--2",level:6},{value:'<code>step</code><sup>Required</sup> <a name="step" id="projen.github.TaskWorkflow.insertStepAfter.parameter.step"></a>',id:"steprequired--4",level:6},{value:'<code>insertStepBefore</code> <a name="insertStepBefore" id="projen.github.TaskWorkflow.insertStepBefore"></a>',id:"insertstepbefore--1",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.TaskWorkflow.insertStepBefore.parameter.jobId"></a>',id:"jobidrequired--10",level:6},{value:'<code>referenceStepId</code><sup>Required</sup> <a name="referenceStepId" id="projen.github.TaskWorkflow.insertStepBefore.parameter.referenceStepId"></a>',id:"referencestepidrequired--3",level:6},{value:'<code>step</code><sup>Required</sup> <a name="step" id="projen.github.TaskWorkflow.insertStepBefore.parameter.step"></a>',id:"steprequired--5",level:6},{value:'<code>on</code> <a name="on" id="projen.github.TaskWorkflow.on"></a>',id:"on--1",level:5},{value:'<code>events</code><sup>Required</sup> <a name="events" id="projen.github.TaskWorkflow.on.parameter.events"></a>',id:"eventsrequired--1",level:6},{value:'<code>patchStep</code> <a name="patchStep" id="projen.github.TaskWorkflow.patchStep"></a>',id:"patchstep--1",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.TaskWorkflow.patchStep.parameter.jobId"></a>',id:"jobidrequired--11",level:6},{value:'<code>stepId</code><sup>Required</sup> <a name="stepId" id="projen.github.TaskWorkflow.patchStep.parameter.stepId"></a>',id:"stepidrequired--5",level:6},{value:'<code>patch</code><sup>Required</sup> <a name="patch" id="projen.github.TaskWorkflow.patchStep.parameter.patch"></a>',id:"patchrequired--1",level:6},{value:'<code>removeJob</code> <a name="removeJob" id="projen.github.TaskWorkflow.removeJob"></a>',id:"removejob--1",level:5},{value:'<code>id</code><sup>Required</sup> <a name="id" id="projen.github.TaskWorkflow.removeJob.parameter.id"></a>',id:"idrequired--6",level:6},{value:'<code>removeStep</code> <a name="removeStep" id="projen.github.TaskWorkflow.removeStep"></a>',id:"removestep--1",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.TaskWorkflow.removeStep.parameter.jobId"></a>',id:"jobidrequired--12",level:6},{value:'<code>stepId</code><sup>Required</sup> <a name="stepId" id="projen.github.TaskWorkflow.removeStep.parameter.stepId"></a>',id:"stepidrequired--6",level:6},{value:'<code>replaceStep</code> <a name="replaceStep" id="projen.github.TaskWorkflow.replaceStep"></a>',id:"replacestep--1",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.TaskWorkflow.replaceStep.parameter.jobId"></a>',id:"jobidrequired--13",level:6},{value:'<code>stepId</code><sup>Required</sup> <a name="stepId" id="projen.github.TaskWorkflow.replaceStep.parameter.stepId"></a>',id:"stepidrequired--7",level:6},{value:'<code>replacementStep</code><sup>Required</sup> <a name="replacementStep" id="projen.github.TaskWorkflow.replaceStep.parameter.replacementStep"></a>',id:"replacementsteprequired--1",level:6},{value:'<code>updateJob</code> <a name="updateJob" id="projen.github.TaskWorkflow.updateJob"></a>',id:"updatejob--1",level:5},{value:'<code>id</code><sup>Required</sup> <a name="id" id="projen.github.TaskWorkflow.updateJob.parameter.id"></a>',id:"idrequired--7",level:6},{value:'<code>job</code><sup>Required</sup> <a name="job" id="projen.github.TaskWorkflow.updateJob.parameter.job"></a>',id:"jobrequired--3",level:6},{value:'<code>updateJobs</code> <a name="updateJobs" id="projen.github.TaskWorkflow.updateJobs"></a>',id:"updatejobs--1",level:5},{value:'<code>jobs</code><sup>Required</sup> <a name="jobs" id="projen.github.TaskWorkflow.updateJobs.parameter.jobs"></a>',id:"jobsrequired--4",level:6},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--14",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.TaskWorkflow.isConstruct"></a>',id:"isconstruct--14",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.TaskWorkflow.isConstruct.parameter.x"></a>',id:"xrequired--28",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.TaskWorkflow.isComponent"></a>',id:"iscomponent--13",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.TaskWorkflow.isComponent.parameter.x"></a>',id:"xrequired--29",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--14",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.TaskWorkflow.property.node"></a>',id:"noderequired--14",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.TaskWorkflow.property.project"></a>',id:"projectrequired--16",level:5},{value:'<code>jobs</code><sup>Required</sup> <a name="jobs" id="projen.github.TaskWorkflow.property.jobs"></a>',id:"jobsrequired--5",level:5},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.TaskWorkflow.property.name"></a>',id:"namerequired--7",level:5},{value:'<code>projenCredentials</code><sup>Required</sup> <a name="projenCredentials" id="projen.github.TaskWorkflow.property.projenCredentials"></a>',id:"projencredentialsrequired--2",level:5},{value:'<code>concurrency</code><sup>Optional</sup> <a name="concurrency" id="projen.github.TaskWorkflow.property.concurrency"></a>',id:"concurrencyoptional--1",level:5},{value:'<code>env</code><sup>Optional</sup> <a name="env" id="projen.github.TaskWorkflow.property.env"></a>',id:"envoptional--1",level:5},{value:'<code>file</code><sup>Optional</sup> <a name="file" id="projen.github.TaskWorkflow.property.file"></a>',id:"fileoptional--1",level:5},{value:'<code>runName</code><sup>Optional</sup> <a name="runName" id="projen.github.TaskWorkflow.property.runName"></a>',id:"runnameoptional--1",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.TaskWorkflow.property.jobId"></a>',id:"jobidrequired--14",level:5},{value:'<code>artifactsDirectory</code><sup>Optional</sup> <a name="artifactsDirectory" id="projen.github.TaskWorkflow.property.artifactsDirectory"></a>',id:"artifactsdirectoryoptional-",level:5},{value:'TaskWorkflowJob <a name="TaskWorkflowJob" id="projen.github.TaskWorkflowJob"></a>',id:"taskworkflowjob-",level:3}

1,{value:'Initializers <a name="Initializers" id="projen.github.TaskWorkflowJob.Initializer"></a>',id:"initializers--15",level:4},{value:'<code>scope</code><sup>Required</sup> <a name="scope" id="projen.github.TaskWorkflowJob.Initializer.parameter.scope"></a>',id:"scoperequired--3",level:5},{value:'<code>task</code><sup>Required</sup> <a name="task" id="projen.github.TaskWorkflowJob.Initializer.parameter.task"></a>',id:"taskrequired--1",level:5},{value:'<code>options</code><sup>Required</sup> <a name="options" id="projen.github.TaskWorkflowJob.Initializer.parameter.options"></a>',id:"optionsrequired--2",level:5},{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--15",level:4},{value:'<code>toString</code> <a name="toString" id="projen.github.TaskWorkflowJob.toString"></a>',id:"tostring--15",level:5},{value:'<code>with</code> <a name="with" id="projen.github.TaskWorkflowJob.with"></a>',id:"with--15",level:5},{value:'<code>mixins</code><sup>Required</sup> <a name="mixins" id="projen.github.TaskWorkflowJob.with.parameter.mixins"></a>',id:"mixinsrequired--15",level:6},{value:'<code>postProjectCreation</code> <a name="postProjectCreation" id="projen.github.TaskWorkflowJob.postProjectCreation"></a>',id:"postprojectcreation--14",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.TaskWorkflowJob.postProjectCreation.parameter.initProject"></a>',id:"initprojectrequired--28",level:6},{value:'<code>postSynthesize</code> <a name="postSynthesize" id="projen.github.TaskWorkflowJob.postSynthesize"></a>',id:"postsynthesize--15",level:5},{value:'<code>preSynthesize</code> <a name="preSynthesize" id="projen.github.TaskWorkflowJob.preSynthesize"></a>',id:"presynthesize--15",level:5},{value:'<code>projectCreation</code> <a name="projectCreation" id="projen.github.TaskWorkflowJob.projectCreation"></a>',id:"projectcreation--14",level:5},{value:'<code>initProject</code><sup>Required</sup> <a name="initProject" id="projen.github.TaskWorkflowJob.projectCreation.parameter.initProject"></a>',id:"initprojectrequired--29",level:6},{value:'<code>synthesize</code> <a name="synthesize" id="projen.github.TaskWorkflowJob.synthesize"></a>',id:"synthesize--14",level:5},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--15",level:4},{value:'<code>isConstruct</code> <a name="isConstruct" id="projen.github.TaskWorkflowJob.isConstruct"></a>',id:"isconstruct--15",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.TaskWorkflowJob.isConstruct.parameter.x"></a>',id:"xrequired--30",level:6},{value:'<code>isComponent</code> <a name="isComponent" id="projen.github.TaskWorkflowJob.isComponent"></a>',id:"iscomponent--14",level:5},{value:'<code>x</code><sup>Required</sup> <a name="x" id="projen.github.TaskWorkflowJob.isComponent.parameter.x"></a>',id:"xrequired--31",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--15",level:4},{value:'<code>node</code><sup>Required</sup> <a name="node" id="projen.github.TaskWorkflowJob.property.node"></a>',id:"noderequired--15",level:5},{value:'<code>project</code><sup>Required</sup> <a name="project" id="projen.github.TaskWorkflowJob.property.project"></a>',id:"projectrequired--17",level:5},{value:'<code>permissions</code><sup>Required</sup> <a name="permissions" id="projen.github.TaskWorkflowJob.property.permissions"></a>',id:"permissionsrequired-",level:5},{value:'<code>steps</code><sup>Required</sup> <a name="steps" id="projen.github.TaskWorkflowJob.property.steps"></a>',id:"stepsrequired-",level:5},{value:'<code>concurrency</code><sup>Optional</sup> <a name="concurrency" id="projen.github.TaskWorkflowJob.property.concurrency"></a>',id:"concurrencyoptional--2",level:5},{value:'<code>container</code><sup>Optional</sup> <a name="container" id="projen.github.TaskWorkflowJob.property.container"></a>',id:"containeroptional-",level:5},{value:'<code>continueOnError</code><sup>Optional</sup> <a name="continueOnError" id="projen.github.TaskWorkflowJob.property.continueOnError"></a>',id:"continueonerroroptional-",level:5},{value:'<code>defaults</code><sup>Optional</sup> <a name="defaults" id="projen.github.TaskWorkflowJob.property.defaults"></a>',id:"defaultsoptional-",level:5},{value:'<code>env</code><sup>Optional</sup> <a name="env" id="projen.github.TaskWorkflowJob.property.env"></a>',id:"envoptional--2",level:5},{value:'<code>environment</code><sup>Optional</sup> <a name="environment" id="projen.github.TaskWorkflowJob.property.environment"></a>',id:"environmentoptional-",level:5},{value:'<code>if</code><sup>Optional</sup> <a name="if" id="projen.github.TaskWorkflowJob.property.if"></a>',id:"ifoptional-",level:5},{value:'<code>name</code><sup>Optional</sup> <a name="name" id="projen.github.TaskWorkflowJob.property.name"></a>',id:"nameoptional-",level:5},{value:'<code>needs</code><sup>Optional</sup> <a name="needs" id="projen.github.TaskWorkflowJob.property.needs"></a>',id:"needsoptional-",level:5},{value:'<code>outputs</code><sup>Optional</sup> <a name="outputs" id="projen.github.TaskWorkflowJob.property.outputs"></a>',id:"outputsoptional-",level:5},{value:'<code>runsOn</code><sup>Optional</sup> <a name="runsOn" id="projen.github.TaskWorkflowJob.property.runsOn"></a>',id:"runsonoptional-",level:5},{value:'<code>runsOnGroup</code><sup>Optional</sup> <a name="runsOnGroup" id="projen.github.TaskWorkflowJob.property.runsOnGroup"></a>',id:"runsongroupoptional-",level:5},{value:'<code>services</code><sup>Optional</sup> <a name="services" id="projen.github.TaskWorkflowJob.property.services"></a>',id:"servicesoptional-",level:5},{value:'<code>strategy</code><sup>Optional</sup> <a name="strategy" id="projen.github.TaskWorkflowJob.property.strategy"></a>',id:"strategyoptional-",level:5},{value:'<code>timeoutMinutes</code><sup>Optional</sup> <a name="timeoutMinutes" id="projen.github.TaskWorkflowJob.property.timeoutMinutes"></a>',id:"timeoutminutesoptional-",level:5},{value:'<code>tools</code><sup>Optional</sup> <a name="tools" id="projen.github.TaskWorkflowJob.property.tools"></a>',id:"toolsoptional-",level:5},{value:'Structs <a name="Structs" id="Structs"></a>',id:"structs-",level:2},{value:'AutoApproveOptions <a name="AutoApproveOptions" id="projen.github.AutoApproveOptions"></a>',id:"autoapproveoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.AutoApproveOptions.Initializer"></a>',id:"initializer-",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--16",level:4},{value:'<code>runsOn</code><sup>Optional</sup> <a name="runsOn" id="projen.github.AutoApproveOptions.property.runsOn"></a>',id:"runsonoptional--1",level:5},{value:'<code>runsOnGroup</code><sup>Optional</sup> <a name="runsOnGroup" id="projen.github.AutoApproveOptions.property.runsOnGroup"></a>',id:"runsongroupoptional--1",level:5},{value:'<code>allowedUsernames</code><sup>Optional</sup> <a name="allowedUsernames" id="projen.github.AutoApproveOptions.property.allowedUsernames"></a>',id:"allowedusernamesoptional-",level:5},{value:'<code>label</code><sup>Optional</sup> <a name="label" id="projen.github.AutoApproveOptions.property.label"></a>',id:"labeloptional-",level:5},{value:'<code>secret</code><sup>Optional</sup> <a name="secret" id="projen.github.AutoApproveOptions.property.secret"></a>',id:"secretoptional-",level:5},{value:'AutoMergeOptions <a name="AutoMergeOptions" id="projen.github.AutoMergeOptions"></a>',id:"automergeoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.AutoMergeOptions.Initializer"></a>',id:"initializer--1",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--17",level:4},{value:'<code>approvedReviews</code><sup>Optional</sup> <a name="approvedReviews" id="projen.github.AutoMergeOptions.property.approvedReviews"></a>',id:"approvedreviewsoptional-",level:5},{value:'<code>blockingLabels</code><sup>Optional</sup> <a name="blockingLabels" id="projen.github.AutoMergeOptions.property.blockingLabels"></a>',id:"blockinglabelsoptional-",level:5},{value:'<code>queueName</code><sup>Optional</sup> <a name="queueName" id="projen.github.AutoMergeOptions.property.queueName"></a>',id:"queuenameoptional-",level:5},{value:'<code>ruleName</code><sup>Optional</sup> <a name="ruleName" id="projen.github.AutoMergeOptions.property.ruleName"></a>',id:"rulenameoptional-",level:5},{value:'AutoQueueOptions <a name="AutoQueueOptions" id="projen.github.AutoQueueOptions"></a>',id:"autoqueueoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.AutoQueueOptions.Initializer"></a>',id:"initializer--2",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--18",level:4},{value:'<code>runsOn</code><sup>Optional</sup> <a name="runsOn" id="projen.github.AutoQueueOptions.property.runsOn"></a>',id:"runsonoptional--2",level:5},{value:'<code>runsOnGroup</code><sup>Optional</sup> <a name="runsOnGroup" id="projen.github.AutoQueueOptions.property.runsOnGroup"></a>',id:"runsongroupoptional--2",level:5},{value:'<code>allowedUsernames</code><sup>Optional</sup> <a name="allowedUsernames" id="projen.github.AutoQueueOptions.property.allowedUsernames"></a>',id:"allowedusernamesoptional--1",level:5},{value:'<code>labels</code><sup>Optional</sup> <a name="labels" id="projen.github.AutoQueueOptions.property.labels"></a>',id:"labelsoptional-",level:5},{value:'<code>mergeMethod</code><sup>Optional</sup> <a name="mergeMethod" id="projen.github.AutoQueueOptions.property.mergeMethod"></a>',id:"mergemethodoptional-",level:5},{value:'<code>projenCredentials</code><sup>Optional</sup> <a name="projenCredentials" id="projen.github.AutoQueueOptions.property.projenCredentials"></a>',id:"projencredentialsoptional-",level:5},{value:'<code>targetBranches</code><sup>Optional</sup> <a name="targetBranches" id="projen.github.AutoQueueOptions.property.targetBranches"></a>',id:"targetbranchesoptional-",level:5},{value:"Automatically merging a set of Stacked PRs",id:"automatically-merging-a-set-of-stacked-prs",level:2},{value:'CheckoutOptions <a name="CheckoutOptions" id="projen.github.CheckoutOptions"></a>',id:"checkoutoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.CheckoutOptions.Initializer"></a>',id:"initializer--3",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--19",level:4},{value:'<code>env</code><sup>Optional</sup> <a name="env" id="projen.github.CheckoutOptions.property.env"></a>',id:"envoptional--3",level:5},{value:'<code>id</code><sup>Optional</sup> <a name="id" id="projen.github.CheckoutOptions.property.id"></a>',id:"idoptional-",level:5},{value:'<code>if</code><sup>Optional</sup> <a name="if" id="projen.github.CheckoutOptions.property.if"></a>',id:"ifoptional--1",level:5},{value:'<code>name</code><sup>Optional</sup> <a name="name" id="projen.github.CheckoutOptions.property.name"></a>',id:"nameoptional--1",level:5},{value:'<code>shell</code><sup>Optional</sup> <a name="shell" id="projen.github.CheckoutOptions.property.shell"></a>',id:"shelloptional-",level:5},{value:'<code>workingDirectory</code><sup>Optional</sup> <a name="workingDirectory" id="projen.github.CheckoutOptions.property.workingDirectory"></a>',id:"workingdirectoryoptional-",level:5},{value:'<code>background</code><sup>Optional</sup> <a name="background" id="projen.github.CheckoutOptions.property.background"></a>',id:"backgroundoptional-",level:5},{value:'<code>cancel</code><sup>Optional</sup> <a name="cancel" id="projen.github.CheckoutOptions.property.cancel"></a>',id:"canceloptional-",level:5},{value:'<code>continueOnError</code><sup>Optional</sup> <a name="continueOnError" id="projen.github.CheckoutOptions.property.continueOnError"></a>',id:"continueonerroroptional--1",level:5},{value:'<code>parallel</code><sup>Optional</sup> <a name="parallel" id="projen.github.CheckoutOptions.property.parallel"></a>',id:"paralleloptional-",level:5},{value:'<code>timeoutMinutes</code><sup>Optional</sup> <a name="timeoutMinutes" id="projen.github.CheckoutOptions.property.timeoutMinutes"></a>',id:"timeoutminutesoptional--1",level:5},{value:'<code>wait</code><sup>Optional</sup> <a name="wait" id="projen.github.CheckoutOptions.property.wait"></a>',id:"waitoptional-",level:5},{value:'<code>waitAll</code><sup>Optional</sup> <a name="waitAll" id="projen.github.CheckoutOptions.property.waitAll"></a>',id:"waitalloptional-",level:5},{value:'<code>with</code><sup>Optional</sup> <a name="with" id="projen.github.CheckoutOptions.property.with"></a>',id:"withoptional-",level:5},{value:'CheckoutWith <a name="CheckoutWith" id="projen.github.CheckoutWith"></a>',id:"checkoutwith-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.CheckoutWith.Initializer"></a>',id:"initializer--4",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--20",level:4},{value:'<code>fetchDepth</code><sup>Optional</sup> <a name="fetchDepth" id="projen.github.CheckoutWith.property.fetchDepth"></a>',id:"fetchdepthoptional-",level:5},{value:'<code>lfs</code><sup>Optional</sup> <a name="lfs" id="projen.github.CheckoutWith.property.lfs"></a>',id:"lfsoptional-",level:5},{value:'<code>path</code><sup>Optional</sup> <a name="path" id="projen.github.CheckoutWith.property.path"></a>',id:"pathoptional-",level:5},{value:'<code>ref</code><sup>Optional</sup> <a name="ref" id="projen.github.CheckoutWith.property.ref"></a>',id:"refoptional-",level:5},{value:'<code>repository</code><sup>Optional</sup> <a name="repository" id="projen.github.CheckoutWith.property.repository"></a>',id:"repositoryoptional-",level:5},{value:'<code>submodules</code><sup>Optional</sup> <a name="submodules" id="projen.github.CheckoutWith.property.submodules"></a>',id:"submodulesoptional-",level:5},{value:'<code>token</code><sup>Optional</sup> <a name="token" id="projen.github.CheckoutWith.property.token"></a>',id:"tokenoptional-",level:5},{value:'CheckoutWithPatchOptions <a name="CheckoutWithPatchOptions" id="projen.github.CheckoutWithPatchOptions"></a>',id:"checkoutwithpatchoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.CheckoutWithPatchOptions.Initializer"></a>',id:"initializer--5",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--21",level:4},{value:'<code>fetchDepth</code><sup>Optional</sup> <a name="fetchDepth" id="projen.github.CheckoutWithPatchOptions.property.fetchDepth"></a>',id:"fetchdepthoptional--1",level:5},{value:'<code>lfs</code><sup>Optional</sup> <a name="lfs" id="projen.github.CheckoutWithPatchOptions.property.lfs"></a>',id:"lfsoptional--1",level:5},{value:'<code>path</code><sup>Optional</sup> <a name="path" id="projen.github.CheckoutWithPatchOptions.property.path"></a>',id:"pathoptional--1",level:5},{value:'<code>ref</code><sup>Optional</sup> <a name="ref" id="projen.github.CheckoutWithPatchOptions.property.ref"></a>',id:"refoptional--1",level:5},{value:'<code>repository</code><sup>Optional</sup> <a name="repository" id="projen.github.CheckoutWithPatchOptions.property.repository"></a>',id:"repositoryoptional--1",level:5},{value:'<code>submodules</code><sup>Optional</sup> <a name="submodules" id="projen.github.CheckoutWithPatchOptions.property.submodules"></a>',id:"submodulesoptional--1",level:5},{value:'<code>token</code><sup>Optional</sup> <a name="token" id="projen.github.CheckoutWithPatchOptions.property.token"></a>',id:"tokenoptional--1",level:5},{value:'<code>patchFile</code><sup>Optional</sup> <a name="patchFile" id="projen.github.CheckoutWithPatchOptions.property.patchFile"></a>',id:"patchfileoptional-",level:5}

1,{value:'ConcurrencyOptions <a name="ConcurrencyOptions" id="projen.github.ConcurrencyOptions"></a>',id:"concurrencyoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.ConcurrencyOptions.Initializer"></a>',id:"initializer--6",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--22",level:4},{value:'<code>cancelInProgress</code><sup>Optional</sup> <a name="cancelInProgress" id="projen.github.ConcurrencyOptions.property.cancelInProgress"></a>',id:"cancelinprogressoptional-",level:5},{value:'<code>group</code><sup>Optional</sup> <a name="group" id="projen.github.ConcurrencyOptions.property.group"></a>',id:"groupoptional-",level:5},{value:'ContributorStatementOptions <a name="ContributorStatementOptions" id="projen.github.ContributorStatementOptions"></a>',id:"contributorstatementoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.ContributorStatementOptions.Initializer"></a>',id:"initializer--7",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--23",level:4},{value:'<code>exemptLabels</code><sup>Optional</sup> <a name="exemptLabels" id="projen.github.ContributorStatementOptions.property.exemptLabels"></a>',id:"exemptlabelsoptional-",level:5},{value:'<code>exemptUsers</code><sup>Optional</sup> <a name="exemptUsers" id="projen.github.ContributorStatementOptions.property.exemptUsers"></a>',id:"exemptusersoptional-",level:5},{value:'CreatePullRequestOptions <a name="CreatePullRequestOptions" id="projen.github.CreatePullRequestOptions"></a>',id:"createpullrequestoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.CreatePullRequestOptions.Initializer"></a>',id:"initializer--8",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--24",level:4},{value:'<code>pullRequestDescription</code><sup>Required</sup> <a name="pullRequestDescription" id="projen.github.CreatePullRequestOptions.property.pullRequestDescription"></a>',id:"pullrequestdescriptionrequired-",level:5},{value:'<code>pullRequestTitle</code><sup>Required</sup> <a name="pullRequestTitle" id="projen.github.CreatePullRequestOptions.property.pullRequestTitle"></a>',id:"pullrequesttitlerequired-",level:5},{value:'<code>workflowName</code><sup>Required</sup> <a name="workflowName" id="projen.github.CreatePullRequestOptions.property.workflowName"></a>',id:"workflownamerequired-",level:5},{value:'<code>addPaths</code><sup>Optional</sup> <a name="addPaths" id="projen.github.CreatePullRequestOptions.property.addPaths"></a>',id:"addpathsoptional-",level:5},{value:'<code>assignees</code><sup>Optional</sup> <a name="assignees" id="projen.github.CreatePullRequestOptions.property.assignees"></a>',id:"assigneesoptional-",level:5},{value:'<code>baseBranch</code><sup>Optional</sup> <a name="baseBranch" id="projen.github.CreatePullRequestOptions.property.baseBranch"></a>',id:"basebranchoptional-",level:5},{value:'<code>branchName</code><sup>Optional</sup> <a name="branchName" id="projen.github.CreatePullRequestOptions.property.branchName"></a>',id:"branchnameoptional-",level:5},{value:'<code>credentials</code><sup>Optional</sup> <a name="credentials" id="projen.github.CreatePullRequestOptions.property.credentials"></a>',id:"credentialsoptional-",level:5},{value:'<code>deleteBranch</code><sup>Optional</sup> <a name="deleteBranch" id="projen.github.CreatePullRequestOptions.property.deleteBranch"></a>',id:"deletebranchoptional-",level:5},{value:'<code>gitIdentity</code><sup>Optional</sup> <a name="gitIdentity" id="projen.github.CreatePullRequestOptions.property.gitIdentity"></a>',id:"gitidentityoptional-",level:5},{value:'<code>labels</code><sup>Optional</sup> <a name="labels" id="projen.github.CreatePullRequestOptions.property.labels"></a>',id:"labelsoptional--1",level:5},{value:'<code>signoff</code><sup>Optional</sup> <a name="signoff" id="projen.github.CreatePullRequestOptions.property.signoff"></a>',id:"signoffoptional-",level:5},{value:'<code>stepId</code><sup>Optional</sup> <a name="stepId" id="projen.github.CreatePullRequestOptions.property.stepId"></a>',id:"stepidoptional-",level:5},{value:'<code>stepName</code><sup>Optional</sup> <a name="stepName" id="projen.github.CreatePullRequestOptions.property.stepName"></a>',id:"stepnameoptional-",level:5},{value:'DependabotAllow <a name="DependabotAllow" id="projen.github.DependabotAllow"></a>',id:"dependabotallow-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.DependabotAllow.Initializer"></a>',id:"initializer--9",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--25",level:4},{value:'<code>dependencyName</code><sup>Required</sup> <a name="dependencyName" id="projen.github.DependabotAllow.property.dependencyName"></a>',id:"dependencynamerequired--2",level:5},{value:'DependabotCooldown <a name="DependabotCooldown" id="projen.github.DependabotCooldown"></a>',id:"dependabotcooldown-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.DependabotCooldown.Initializer"></a>',id:"initializer--10",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--26",level:4},{value:'<code>defaultDays</code><sup>Optional</sup> <a name="defaultDays" id="projen.github.DependabotCooldown.property.defaultDays"></a>',id:"defaultdaysoptional-",level:5},{value:'<code>exclude</code><sup>Optional</sup> <a name="exclude" id="projen.github.DependabotCooldown.property.exclude"></a>',id:"excludeoptional-",level:5},{value:'<code>include</code><sup>Optional</sup> <a name="include" id="projen.github.DependabotCooldown.property.include"></a>',id:"includeoptional-",level:5},{value:'<code>semverMajorDays</code><sup>Optional</sup> <a name="semverMajorDays" id="projen.github.DependabotCooldown.property.semverMajorDays"></a>',id:"semvermajordaysoptional-",level:5},{value:'<code>semverMinorDays</code><sup>Optional</sup> <a name="semverMinorDays" id="projen.github.DependabotCooldown.property.semverMinorDays"></a>',id:"semverminordaysoptional-",level:5},{value:'<code>semverPatchDays</code><sup>Optional</sup> <a name="semverPatchDays" id="projen.github.DependabotCooldown.property.semverPatchDays"></a>',id:"semverpatchdaysoptional-",level:5}

1,{value:'DependabotGroup <a name="DependabotGroup" id="projen.github.DependabotGroup"></a>',id:"dependabotgroup-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.DependabotGroup.Initializer"></a>',id:"initializer--11",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--27",level:4},{value:'<code>patterns</code><sup>Required</sup> <a name="patterns" id="projen.github.DependabotGroup.property.patterns"></a>',id:"patternsrequired-",level:5},{value:'<code>appliesTo</code><sup>Optional</sup> <a name="appliesTo" id="projen.github.DependabotGroup.property.appliesTo"></a>',id:"appliestooptional-",level:5},{value:'<code>dependencyType</code><sup>Optional</sup> <a name="dependencyType" id="projen.github.DependabotGroup.property.dependencyType"></a>',id:"dependencytypeoptional-",level:5},{value:'<code>excludePatterns</code><sup>Optional</sup> <a name="excludePatterns" id="projen.github.DependabotGroup.property.excludePatterns"></a>',id:"excludepatternsoptional-",level:5},{value:'<code>updateTypes</code><sup>Optional</sup> <a name="updateTypes" id="projen.github.DependabotGroup.property.updateTypes"></a>',id:"updatetypesoptional-",level:5},{value:'DependabotIgnore <a name="DependabotIgnore" id="projen.github.DependabotIgnore"></a>',id:"dependabotignore-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.DependabotIgnore.Initializer"></a>',id:"initializer--12",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--28",level:4},{value:'<code>dependencyName</code><sup>Required</sup> <a name="dependencyName" id="projen.github.DependabotIgnore.property.dependencyName"></a>',id:"dependencynamerequired--3",level:5},{value:'<code>versions</code><sup>Optional</sup> <a name="versions" id="projen.github.DependabotIgnore.property.versions"></a>',id:"versionsoptional-",level:5},{value:'DependabotOptions <a name="DependabotOptions" id="projen.github.DependabotOptions"></a>',id:"dependabotoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.DependabotOptions.Initializer"></a>',id:"initializer--13",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--29",level:4},{value:'<code>allow</code><sup>Optional</sup> <a name="allow" id="projen.github.DependabotOptions.property.allow"></a>',id:"allowoptional-",level:5},{value:'<code>assignees</code><sup>Optional</sup> <a name="assignees" id="projen.github.DependabotOptions.property.assignees"></a>',id:"assigneesoptional--1",level:5},{value:'<code>cooldown</code><sup>Optional</sup> <a name="cooldown" id="projen.github.DependabotOptions.property.cooldown"></a>',id:"cooldownoptional-",level:5},{value:'<code>groups</code><sup>Optional</sup> <a name="groups" id="projen.github.DependabotOptions.property.groups"></a>',id:"groupsoptional-",level:5},{value:'<code>ignore</code><sup>Optional</sup> <a name="ignore" id="projen.github.DependabotOptions.property.ignore"></a>',id:"ignoreoptional-",level:5},{value:'<code>ignoreProjen</code><sup>Optional</sup> <a name="ignoreProjen" id="projen.github.DependabotOptions.property.ignoreProjen"></a>',id:"ignoreprojenoptional-",level:5},{value:'<code>labels</code><sup>Optional</sup> <a name="labels" id="projen.github.DependabotOptions.property.labels"></a>',id:"labelsoptional--2",level:5},{value:'<code>openPullRequestsLimit</code><sup>Optional</sup> <a name="openPullRequestsLimit" id="projen.github.DependabotOptions.property.openPullRequestsLimit"></a>',id:"openpullrequestslimitoptional-",level:5},{value:'<code>registries</code><sup>Optional</sup> <a name="registries" id="projen.github.DependabotOptions.property.registries"></a>',id:"registriesoptional-",level:5},{value:'<code>reviewers</code><sup>Optional</sup> <a name="reviewers" id="projen.github.DependabotOptions.property.reviewers"></a>',id:"reviewersoptional-",level:5},{value:'<code>scheduleInterval</code><sup>Optional</sup> <a name="scheduleInterval" id="projen.github.DependabotOptions.property.scheduleInterval"></a>',id:"scheduleintervaloptional-",level:5},{value:'<code>targetBranch</code><sup>Optional</sup> <a name="targetBranch" id="projen.github.DependabotOptions.property.targetBranch"></a>',id:"targetbranchoptional-",level:5},{value:'<code>versioningStrategy</code><sup>Optional</sup> <a name="versioningStrategy" id="projen.github.DependabotOptions.property.versioningStrategy"></a>',id:"versioningstrategyoptional-",level:5},{value:'DependabotRegistry <a name="DependabotRegistry" id="projen.github.DependabotRegistry"></a>',id:"dependabotregistry-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.DependabotRegistry.Initializer"></a>',id:"initializer--14",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--30",level:4},{value:'<code>type</code><sup>Required</sup> <a name="type" id="projen.github.DependabotRegistry.property.type"></a>',id:"typerequired-",level:5},{value:'<code>url</code><sup>Required</sup> <a name="url" id="projen.github.DependabotRegistry.property.url"></a>',id:"urlrequired-",level:5},{value:'<code>key</code><sup>Optional</sup> <a name="key" id="projen.github.DependabotRegistry.property.key"></a>',id:"keyoptional-",level:5},{value:'<code>organization</code><sup>Optional</sup> <a name="organization" id="projen.github.DependabotRegistry.property.organization"></a>',id:"organizationoptional-",level:5},{value:'<code>password</code><sup>Optional</sup> <a name="password" id="projen.github.DependabotRegistry.property.password"></a>',id:"passwordoptional-",level:5},{value:'<code>replacesBase</code><sup>Optional</sup> <a name="replacesBase" id="projen.github.DependabotRegistry.property.replacesBase"></a>',id:"replacesbaseoptional-",level:5},{value:'<code>token</code><sup>Optional</sup> <a name="token" id="projen.github.DependabotRegistry.property.token"></a>',id:"tokenoptional--2",level:5},{value:'<code>username</code><sup>Optional</sup> <a name="username" id="projen.github.DependabotRegistry.property.username"></a>',id:"usernameoptional-",level:5},{value:'DependencyReviewOptions <a name="DependencyReviewOptions" id="projen.github.DependencyReviewOptions"></a>',id:"dependencyreviewoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.DependencyReviewOptions.Initializer"></a>',id:"initializer--15",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--31",level:4},{value:'<code>runsOn</code><sup>Optional</sup> <a name="runsOn" id="projen.github.DependencyReviewOptions.property.runsOn"></a>',id:"runsonoptional--3",level:5},{value:'<code>runsOnGroup</code><sup>Optional</sup> <a name="runsOnGroup" id="projen.github.DependencyReviewOptions.property.runsOnGroup"></a>',id:"runsongroupoptional--3",level:5},{value:'<code>allowGhsas</code><sup>Optional</sup> <a name="allowGhsas" id="projen.github.DependencyReviewOptions.property.allowGhsas"></a>',id:"allowghsasoptional-",level:5},{value:'<code>allowLicenses</code><sup>Optional</sup> <a name="allowLicenses" id="projen.github.DependencyReviewOptions.property.allowLicenses"></a>',id:"allowlicensesoptional-",level:5},{value:'<code>commentSummaryInPr</code><sup>Optional</sup> <a name="commentSummaryInPr" id="projen.github.DependencyReviewOptions.property.commentSummaryInPr"></a>',id:"commentsummaryinproptional-",level:5},{value:'<code>configFile</code><sup>Optional</sup> <a name="configFile" id="projen.github.DependencyReviewOptions.property.configFile"></a>',id:"configfileoptional-",level:5},{value:'<code>denyPackages</code><sup>Optional</sup> <a name="denyPackages" id="projen.github.DependencyReviewOptions.property.denyPackages"></a>',id:"denypackagesoptional-",level:5},{value:'<code>failOnScopes</code><sup>Optional</sup> <a name="failOnScopes" id="projen.github.DependencyReviewOptions.property.failOnScopes"></a>

1',id:"failonscopesoptional-",level:5},{value:'<code>failOnSeverity</code><sup>Optional</sup> <a name="failOnSeverity" id="projen.github.DependencyReviewOptions.property.failOnSeverity"></a>',id:"failonseverityoptional-",level:5},{value:'<code>licenseCheck</code><sup>Optional</sup> <a name="licenseCheck" id="projen.github.DependencyReviewOptions.property.licenseCheck"></a>',id:"licensecheckoptional-",level:5},{value:'<code>showOpenSSFScorecard</code><sup>Optional</sup> <a name="showOpenSSFScorecard" id="projen.github.DependencyReviewOptions.property.showOpenSSFScorecard"></a>',id:"showopenssfscorecardoptional-",level:5},{value:'<code>vulnerabilityCheck</code><sup>Optional</sup> <a name="vulnerabilityCheck" id="projen.github.DependencyReviewOptions.property.vulnerabilityCheck"></a>',id:"vulnerabilitycheckoptional-",level:5},{value:'<code>warnOnly</code><sup>Optional</sup> <a name="warnOnly" id="projen.github.DependencyReviewOptions.property.warnOnly"></a>',id:"warnonlyoptional-",level:5},{value:'<code>warnOnOpenSSFScorecardLevel</code><sup>Optional</sup>

1 <a name="warnOnOpenSSFScorecardLevel" id="projen.github.DependencyReviewOptions.property.warnOnOpenSSFScorecardLevel"></a>',id:"warnonopenssfscorecardleveloptional-",level:5},{value:'DownloadArtifactOptions <a name="DownloadArtifactOptions" id="projen.github.DownloadArtifactOptions"></a>',id:"downloadartifactoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.DownloadArtifactOptions.Initializer"></a>',id:"initializer--16",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--32",level:4},{value:'<code>env</code><sup>Optional</sup> <a name="env" id="projen.github.DownloadArtifactOptions.property.env"></a>',id:"envoptional--4",level:5},{value:'<code>id</code><sup>Optional</sup> <a name="id" id="projen.github.DownloadArtifactOptions.property.id"></a>',id:"idoptional--1",level:5},{value:'<code>if</code><sup>Optional</sup> <a name="if" id="projen.github.DownloadArtifactOptions.property.if"></a>',id:"ifoptional--2",level:5},{value:'<code>name</code><sup>Optional</sup> <a name="name" id="projen.github.DownloadArtifactOptions.property.name"></a>',id:"nameoptional--2",level:5},{value:'<code>shell</code><sup>Optional</sup> <a name="shell" id="projen.github.DownloadArtifactOptions.property.shell"></a>',id:"shelloptional--1",level:5},{value:'<code>workingDirectory</code><sup>Optional</sup> <a name="workingDirectory" id="projen.github.DownloadArtifactOptions.property.workingDirectory"></a>',id:"workingdirectoryoptional--1",level:5},{value:'<code>background</code><sup>Optional</sup> <a name="background" id="projen.github.DownloadArtifactOptions.property.background"></a>',id:"backgroundoptional--1",level:5},{value:'<code>cancel</code><sup>Optional</sup> <a name="cancel" id="projen.github.DownloadArtifactOptions.property.cancel"></a>',id:"canceloptional--1",level:5},{value:'<code>continueOnError</code><sup>Optional</sup> <a name="continueOnError" id="projen.github.DownloadArtifactOptions.property.continueOnError"></a>',id:"continueonerroroptional--2",level:5},{value:'<code>parallel</code><sup>Optional</sup> <a name="parallel" id="projen.github.DownloadArtifactOptions.property.parallel"></a>',id:"paralleloptional--1",level:5},{value:'<code>timeoutMinutes</code><sup>Optional</sup> <a name="timeoutMinutes" id="projen.github.DownloadArtifactOptions.property.timeoutMinutes"></a>',id:"timeoutminutesoptional--2",level:5},{value:'<code>wait</code><sup>Optional</sup> <a name="wait" id="projen.github.DownloadArtifactOptions.property.wait"></a>',id:"waitoptional--1",level:5},{value:'<code>waitAll</code><sup>Optional</sup> <a name="waitAll" id="projen.github.DownloadArtifactOptions.property.waitAll"></a>',id:"waitalloptional--1",level:5},{value:'<code>with</code><sup>Required</sup> <a name="with" id="projen.github.DownloadArtifactOptions.property.with"></a>',id:"withrequired-",level:5},{value:'DownloadArtifactWith <a name="DownloadArtifactWith" id="projen.github.DownloadArtifactWith"></a>',id:"downloadartifactwith-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.DownloadArtifactWith.Initializer"></a>',id:"initializer--17",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--33",level:4},{value:'<code>artifactIds</code><sup>Optional</sup> <a name="artifactIds" id="projen.github.DownloadArtifactWith.property.artifactIds"></a>',id:"artifactidsoptional-",level:5},{value:'<code>mergeMultiple</code><sup>Optional</sup> <a name="mergeMultiple" id="projen.github.DownloadArtifactWith.property.mergeMultiple"></a>',id:"mergemultipleoptional-",level:5},{value:'<code>name</code><sup>Optional</sup> <a name="name" id="projen.github.DownloadArtifactWith.property.name"></a>',id:"nameoptional--3",level:5},{value:'<code>path</code><sup>Optional</sup> <a name="path" id="projen.github.DownloadArtifactWith.property.path"></a>',id:"pathoptional--2",level:5},{value:'<code>pattern</code><sup>Optional</sup> <a name="pattern" id="projen.github.DownloadArtifactWith.property.pattern"></a>',id:"patternoptional-",level:5},{value:'<code>repository</code><sup>Optional</sup> <a name="repository" id="projen.github.DownloadArtifactWith.property.repository"></a>',id:"repositoryoptional--2",level:5},{value:'<code>runId</code><sup>Optional</sup> <a name="runId" id="projen.github.DownloadArtifactWith.property.runId"></a>',id:"runidoptional-",level:5},{value:'<code>token</code><sup>Optional</sup> <a name="token" id="projen.github.DownloadArtifactWith.property.token"></a>',id:"tokenoptional--3",level:5},{value:'GithubCredentialsAppOptions <a name="GithubCredentialsAppOptions" id="projen.github.GithubCredentialsAppOptions"></a>

1',id:"githubcredentialsappoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.GithubCredentialsAppOptions.Initializer"></a>',id:"initializer--18",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--34",level:4},{value:'<code>appIdSecret</code><sup>Optional</sup> <a name="appIdSecret" id="projen.github.GithubCredentialsAppOptions.property.appIdSecret"></a>',id:"appidsecretoptional-",level:5},{value:'<code>environment</code><sup>Optional</sup> <a name="environment" id="projen.github.GithubCredentialsAppOptions.property.environment"></a>',id:"environmentoptional--1",level:5},{value:'<code>owner</code><sup>Optional</sup> <a name="owner" id="projen.github.GithubCredentialsAppOptions.property.owner"></a>',id:"owneroptional-",level:5},{value:'<code>permissions</code><sup>Optional</sup> <a name="permissions" id="projen.github.GithubCredentialsAppOptions.property.permissions"></a>',id:"permissionsoptional-",level:5},{value:'<code>privateKeySecret</code><sup>Optional</sup> <a name="privateKeySecret" id="projen.github.GithubCredentialsAppOptions.property.privateKeySecret"></a>',id:"privatekeysecretoptional-",level:5},{value:'<code>repositories</code><sup>Optional</sup> <a name="repositories" id="projen.github.GithubCredentialsAppOptions.property.repositories"></a>',id:"repositoriesoptional-",level:5},{value:'GithubCredentialsPersonalAccessTokenOptions <a name="GithubCredentialsPersonalAccessTokenOptions" id="projen.github.GithubCredentialsPersonalAccessTokenOptions"></a>',id:"githubcredentialspersonalaccesstokenoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.GithubCredentialsPersonalAccessTokenOptions.Initializer"></a>',id:"initializer--19",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--35",level:4},{value:'<code>environment</code><sup>Optional</sup> <a name="environment" id="projen.github.GithubCredentialsPersonalAccessTokenOptions.property.environment"></a>',id:"environmentoptional--2",level:5},{value:'<code>secret</code><sup>Optional</sup> <a name="secret" id="projen.github.GithubCredentialsPersonalAccessTokenOptions.property.secret"></a>',id:"secretoptional--1",level:5},{value:'GitHubOptions <a name="GitHubOptions" id="projen.github.GitHubOptions"></a>',id:"githuboptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.GitHubOptions.Initializer"></a>',id:"initializer--20",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--36",level:4},{value:'<code>checkoutSubmodules</code><sup>Optional</sup> <a name="checkoutSubmodules" id="projen.github.GitHubOptions.property.checkoutSubmodules"></a>',id:"checkoutsubmodulesoptional-",level:5},{value:'<code>dependencyReview</code><sup>Optional</sup> <a name="dependencyReview" id="projen.github.GitHubOptions.property.dependencyReview"></a>',id:"dependencyreviewoptional-",level:5},{value:'<code>dependencyReviewOptions</code><sup>Optional</sup> <a name="dependencyReviewOptions" id="projen.github.GitHubOptions.property.dependencyReviewOptions"></a>',id:"dependencyreviewoptionsoptional-",level:5},{value:'<code>downloadLfs</code><sup>Optional</sup> <a name="downloadLfs" id="projen.github.GitHubOptions.property.downloadLfs"></a>',id:"downloadlfsoptional-",level:5},{value:'<code>mergeQueue</code><sup>Optional</sup> <a name="mergeQueue" id="projen.github.GitHubOptions.property.mergeQueue"></a>',id:"mergequeueoptional--1",level:5},{value:'<code>mergeQueueOptions</code><sup>Optional</sup> <a name="mergeQueueOptions" id="projen.github.GitHubOptions.property.mergeQueueOptions"></a>',id:"mergequeueoptionsoptional-",level:5},{value:'<code>mergify</code><sup>Optional</sup> <a name="mergify" id="projen.github.GitHubOptions.property.mergify"></a>',id:"mergifyoptional--1",level:5},{value:'<code>mergifyOptions</code><sup>Optional</sup> <a name="mergifyOptions" id="projen.github.GitHubOptions.property.mergifyOptions"></a>',id:"mergifyoptionsoptional-",level:5},{value:'<code>projenCredentials</code><sup>Optional</sup> <a name="projenCredentials" id="projen.github.GitHubOptions.property.projenCredentials"></a>',id:"projencredentialsoptional--1",level:5},{value:'<code>pullRequestBackport</code><sup>Optional</sup> <a name="pullRequestBackport" id="projen.github.GitHubOptions.property.pullRequestBackport"></a>',id:"pullrequestbackportoptional-",level:5},{value:'<code>pullRequestBackportOptions</code><sup>Optional</sup> <a name="pullRequestBackportOptions" id="projen.github.GitHubOptions.property.pullRequestBackportOptions"></a>',id:"pullrequestbackportoptionsoptional-",level:5},{value:'<code>pullRequestLint</code><sup>Optional</sup> <a name="pullRequestLint" id="projen.github.GitHubOptions.property.pullRequestLint"></a>',id:"pullrequestlintoptional-",level:5},{value:'<code>pullRequestLintOptions</code><sup>Optional</sup> <a name="pullRequestLintOptions" id="projen.github.GitHubOptions.property.pullRequestLintOptions"></a>',id:"pullrequestlintoptionsoptional-",level:5},{value:'<code>workflowRunsOn</code><sup>Optional</sup> <a name="workflowRunsOn" id="projen.github.GitHubOptions.property.workflowRunsOn"></a>',id:"workflowrunsonoptional-",level:5},{value:'<code>workflowRunsOnGroup</code><sup>Optional</sup> <a name="workflowRunsOnGroup" id="projen.github.GitHubOptions.property.workflowRunsOnGroup"></a>',id:"workflowrunsongroupoptional-",level:5},{value:'<code>workflows</code><sup>Optional</sup> <a name="workflows" id="projen.github.GitHubOptions.property.workflows"></a>',id:"workflowsoptional-",level:5},{value:'GitHubProjectOptions <a name="GitHubProjectOptions" id="projen.github.GitHubProjectOptions"></a>',id:"githubprojectoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.GitHubProjectOptions.Initializer"></a>',id:"initializer--21",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--37",level:4},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.GitHubProjectOptions.property.name"></a>',id:"namerequired--8",level:5},{value:'<code>commitGenerated</code><sup>Optional</sup> <a name="commitGenerated" id="projen.github.GitHubProjectOptions.property.commitGenerated"></a>',id:"commitgeneratedoptional-",level:5},{value:'<code>gitIgnoreOptions</code><sup>Optional</sup> <a name="gitIgnoreOptions" id="projen.github.GitHubProjectOptions.property.gitIgnoreOptions"></a>',id:"gitignoreoptionsoptional-",level:5},{value:'<code>gitOptions</code><sup>Optional</sup> <a name="gitOptions" id="projen.github.GitHubProjectOptions.property.gitOptions"></a>',id:"gitoptionsoptional-",level:5},{value:'<code>logging</code><sup>Optional</sup> <a name="logging" id="projen.github.GitHubProjectOptions.property.logging"></a>',id:"loggingoptional-",level:5},{value:'<code>outdir</code><sup>Optional</sup> <a name="outdir" id="projen.github.GitHubProjectOptions.property.outdir"></a>',id:"outdiroptional-",level:5},{value:'<code>parent</code><sup>Optional</sup> <a name="parent" id="projen.github.GitHubProjectOptions.property.parent"></a>',id:"parentoptional--1",level:5},{value:'<code>projectTree</code><sup>Optional</sup> <a name="projectTree" id="projen.github.GitHubProjectOptions.property.projectTree"></a>',id:"projecttreeoptional-",level:5},{value:'<code>projenCommand</code><sup>Optional</sup> <a name="projenCommand" id="projen.github.GitHubProjectOptions.property.projenCommand"></a>',id:"projencommandoptional-",level:5},{value:'<code>projenrcJson</code><sup>Optional</sup> <a name="projenrcJson" id="projen.github.GitHubProjectOptions.property.projenrcJson"></a>',id:"projenrcjsonoptional-",level:5},{value:'<code>projenrcJsonOptions</code><sup>Optional</sup> <a name="projenrcJsonOptions" id="projen.github.GitHubProjectOptions.property.projenrcJsonOptions"></a>',id:"projenrcjsonoptionsoptional-",level:5},{value:'<code>renovatebot</code><sup>Optional</sup> <a name="renovatebot" id="projen.github.GitHubProjectOptions.property.renovatebot"></a>',id:"renovatebotoptional-",level:5},{value:'<code>renovatebotOptions</code><sup>Optional</sup> <a name="renovatebotOptions" id="projen.github.GitHubProjectOptions.property.renovatebotOptions"></a>',id:"renovatebotoptionsoptional-",level:5},{value:'<code>autoApproveOptions</code><sup>Optional</sup> <a name="autoApproveOptions" id="projen.github.GitHubProjectOptions.property.autoApproveOptions"></a>',id:"autoapproveoptionsoptional-",level:5},{value:'<code>autoMerge</code><sup>Optional</sup> <a name="autoMerge" id="projen.github.GitHubProjectOptions.property.autoMerge"></a>',id:"automergeoptional-",level:5},{value:'<code>autoMergeOptions</code><sup>Optional</sup> <a name="autoMergeOptions" id="projen.github.GitHubProjectOptions.property.autoMergeOptions"></a>',id:"automergeoptionsoptional-",level:5},{value:'<code>clobber</code><sup>Optional</sup> <a name="clobber" id="projen.github.GitHubProjectOptions.property.clobber"></a>',id:"clobberoptional-",level:5},{value:'<code>devContainer</code><sup>Optional</sup> <a name="devContainer" id="projen.github.GitHubProjectOptions.property.devContainer"></a>',id:"devcontaineroptional--1",level:5},{value:'<code>github</code><sup>Optional</sup> <a name="github" id="projen.github.GitHubProjectOptions.property.github"></a>',id:"githuboptional--1",level:5},{value:'<code>githubOptions</code><sup>Optional</sup> <a name="githubOptions" id="projen.github.GitHubProjectOptions.property.githubOptions"></a>',id:"githuboptionsoptional-",level:5},{value:'<code>gitpod</code><sup>Optional</sup> <a name="gitpod" id="projen.github.GitHubProjectOptions.property.gitpod"></a>',id:"gitpodoptional--1",level:5},{value:'<code>projenCredentials</code><sup>Optional</sup> <a name="projenCredentials" id="projen.github.GitHubProjectOptions.property.projenCredentials"></a>',id:"projencredentialsoptional--2",level:5},{value:'<code>readme</code><sup>Optional</sup> <a name="readme" id="projen.github.GitHubProjectOptions.property.readme"></a>',id:"readmeoptional-",level:5},{value:'<code>stale</code><sup>Optional</sup> <a name="stale" id="projen.github.GitHubProjectOptions.property.stale"></a>',id:"staleoptional-",level:5},{value:'<code>staleOptions</code><sup>Optional</sup> <a name="staleOptions" id="projen.github.GitHubProjectOptions.property.staleOptions"></a>',id:"staleoptionsoptional-",level:5},{value:'<code>vscode</code><sup>Optional</sup> <a name="vscode" id="projen.github.GitHubProjectOptions.property.vscode"></a>',id:"vscodeoptional--1",level:5},{value:'GithubWorkflowOptions <a name="GithubWorkflowOptions" id="projen.github.GithubWorkflowOptions"></a>',id:"githubworkflowoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.GithubWorkflowOptions.Initializer"></a>',id:"initializer--22",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--38",level:4},{value:'<code>concurrencyOptions</code><sup>Optional</sup> <a name="concurrencyOptions" id="projen.github.GithubWorkflowOptions.property.concurrencyOptions"></a>',id:"concurrencyoptionsoptional-",level:5},{value:'<code>env</code><sup>Optional</sup> <a name="env" id="projen.github.GithubWorkflowOptions.property.env"></a>',id:"envoptional--5",level:5},{value:'<code>fileName</code><sup>Optional</sup> <a name="fileName" id="projen.github.GithubWorkflowOptions.property.fileName"></a>',id:"filenameoptional-",level:5},{value:'<code>

1force</code><sup>Optional</sup> <a name="force" id="projen.github.GithubWorkflowOptions.property.force"></a>',id:"forceoptional-",level:5},{value:'<code>limitConcurrency</code><sup>Optional</sup> <a name="limitConcurrency" id="projen.github.GithubWorkflowOptions.property.limitConcurrency"></a>',id:"limitconcurrencyoptional-",level:5},{value:'GitIdentity <a name="GitIdentity" id="projen.github.GitIdentity"></a>',id:"gitidentity-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.GitIdentity.Initializer"></a>',id:"initializer--23",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--39",level:4},{value:'<code>email</code><sup>Required</sup> <a name="email" id="projen.github.GitIdentity.property.email"></a>',id:"emailrequired-",level:5},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.GitIdentity.property.name"></a>',id:"namerequired--9",level:5},{value:'MergeQueueOptions <a name="MergeQueueOptions" id="projen.github.MergeQueueOptions"></a>',id:"mergequeueoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.MergeQueueOptions.Initializer"></a>',id:"initializer--24",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--40",level:4},{value:'<code>autoQueue</code><sup>Optional</sup> <a name="autoQueue" id="projen.github.MergeQueueOptions.property.autoQueue"></a>',id:"autoqueueoptional-",level:5},{value:'<code>autoQueueOptions</code><sup>Optional</sup> <a name="autoQueueOptions" id="projen.github.MergeQueueOptions.property.autoQueueOptions"></a>',id:"autoqueueoptionsoptional-",level:5},{value:'<code>targetBranches</code><sup>Optional</sup> <a name="targetBranches" id="projen.github.MergeQueueOptions.property.targetBranches"></a>',id:"targetbranchesoptional--1",level:5},{value:'MergifyCommitMessageFormat <a name="MergifyCommitMessageFormat" id="projen.github.MergifyCommitMessageFormat"></a>',id:"mergifycommitmessageformat-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.MergifyCommitMessageFormat.Initializer"></a>',id:"initializer--25",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--41",level:4},{value:'<code>body</code><sup>Optional</sup> <a name="body" id="projen.github.MergifyCommitMessageFormat.property.body"></a>',id:"bodyoptional-",level:5},{value:'<code>title</code><sup>Optional</sup> <a name="title" id="projen.github.MergifyCommitMessageFormat.property.title"></a>',id:"titleoptional-",level:5},{value:'<code>trailers</code><sup>Optional</sup> <a name="trailers" id="projen.github.MergifyCommitMessageFormat.property.trailers"></a>',id:"trailersoptional-",level:5},{value:'MergifyConditionalOperator <a name="MergifyConditionalOperator" id="projen.github.MergifyConditionalOperator"></a>',id:"mergifyconditionaloperator-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.MergifyConditionalOperator.Initializer"></a>',id:"initializer--26",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--42",level:4},{value:'<code>and</code><sup>Optional</sup> <a name="and" id="projen.github.MergifyConditionalOperator.property.and"></a>',id:"andoptional-",level:5},{value:'<code>or</code><sup>Optional</sup> <a name="or" id="projen.github.MergifyConditionalOperator.property.or"></a>',id:"oroptional-",level:5},{value:'MergifyOptions <a name="MergifyOptions" id="projen.github.MergifyOptions"></a>',id:"mergifyoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.MergifyOptions.Initializer"></a>',id:"initializer--27",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--43",level:4},{value:'<code>queues</code><sup>Optional</sup> <a name="queues" id="projen.github.MergifyOptions.property.queues"></a>',id:"queuesoptional-",level:5},{value:'<code>rules</code><sup>Optional</sup> <a name="rules" id="projen.github.MergifyOptions.property.rules"></a>',id:"rulesoptional-",level:5},{value:'MergifyQueue <a name="MergifyQueue" id="projen.github.MergifyQueue"></a>',id:"mergifyqueue-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.MergifyQueue.Initializer"></a>',id:"initializer--28",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--44",level:4},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.MergifyQueue.property.name"></a>',id:"namerequired--10",level:5},{value:'<code>commitMessageFormat</code><sup>Optional</sup> <a name="commitMessageFormat" id="projen.github.MergifyQueue.property.commitMessageFormat"></a>',id:"commitmessageformatoptional-",level:5},{value:'<del><code>commitMessageTemplate</code></del><sup>Optional</sup> <a name="commitMessageTemplate" id="projen.github.MergifyQueue.property.commitMessageTemplate"></a>',id:"commitmessagetemplateoptional-",level:5},{value:'<code>mergeConditions</code><sup>Optional</sup> <a name="mergeConditions" id="projen.github.MergifyQueue.property.mergeConditions"></a>',id:"mergeconditionsoptional-",level:5},{value:'<code>mergeMethod</code><sup>Optional</sup> <a name="mergeMethod" id="projen.github.MergifyQueue.property.mergeMethod"></a>',id:"mergemethodoptional--1",level:5},{value:'<code>queueConditions</code><sup>Optional</sup> <a name="queueConditions" id="projen.github.MergifyQueue.property.queueConditions"></a>',id:"queueconditionsoptional-",level:5},{value:'<code>updateMethod</code><sup>Optional</sup> <a name="updateMethod" id="projen.github.MergifyQueue.property.updateMethod"></a>',id:"updatemethodoptional-",level:5},{value:'MergifyRule <a name="MergifyRule" id="projen.github.MergifyRule"></a>',id:"mergifyrule-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.MergifyRule.Initializer"></a>',id:"initializer--29",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--45",level:4},{value:'<code>actions</code><sup>Required</sup> <a name="actions" id="projen.github.MergifyRule.property.actions"></a>',id:"actionsrequired--1",level:5},{value:'<code>conditions</code><sup>Required</sup> <a name="conditions" id="projen.github.MergifyRule.property.conditions"></a>',id:"conditionsrequired--1",level:5},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.MergifyRule.property.name"></a>',id:"namerequired--11",level:5},{value:'PullRequestBackportOptions <a name="PullRequestBackportOptions" id="projen.github.PullRequestBackportOptions"></a>',id:"pullrequestbackportoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.PullRequestBackportOptions.Initializer"></a>',id:"initializer--30",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--46",level:4},{value:'<code>runsOn</code><sup>Optional</sup> <a name="runsOn" id="projen.github.PullRequestBackportOptions.property.runsOn"></a>',id:"runsonoptional--4",level:5},{value:'<code>runsOnGroup</code><sup>Optional</sup> <a name="runsOnGroup" id="projen.github.PullRequestBackportOptions.property.runsOnGroup"></a>',id:"runsongroupoptional--4",level:5},{value:'<code>autoApproveBackport</code><sup>Optional</sup> <a name="autoApproveBackport" id="projen.github.PullRequestBackportOptions.property.autoApproveBackport"></a>',id:"autoapprovebackportoptional-",level:5},{value:'<code>backportBranchNamePrefix</code><sup>Optional</sup> <a name="backportBranchNamePrefix" id="projen.github.PullRequestBackportOptions.property.backp

1ortBranchNamePrefix"></a>',id:"backportbranchnameprefixoptional-",level:5},{value:'<code>backportPRLabels</code><sup>Optional</sup> <a name="backportPRLabels" id="projen.github.PullRequestBackportOptions.property.backportPRLabels"></a>',id:"backportprlabelsoptional-",level:5},{value:'<code>branches</code><sup>Optional</sup> <a name="branches" id="projen.github.PullRequestBackportOptions.property.branches"></a>',id:"branchesoptional-",level:5},{value:'<code>createWithConflicts</code><sup>Optional</sup> <a name="createWithConflicts" id="projen.github.PullRequestBackportOptions.property.createWithConflicts"></a>',id:"createwithconflictsoptional-",level:5},{value:'<code>labelPrefix</code><sup>Optional</sup> <a name="labelPrefix" id="projen.github.PullRequestBackportOptions.property.labelPrefix"></a>',id:"labelprefixoptional-",level:5},{value:'<code>workflowName</code><sup>Optional</sup> <a name="workflowName" id="projen.github.PullRequestBackportOptions.property.workflowName"></a>',id:"workflownameoptional-",level:5},{value:'PullRequestFromPatchOptions <a name="PullRequestFromPatchOptions" id="projen.github.PullRequestFromPatchOptions"></a>',id:"pullrequestfrompatchoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.PullRequestFromPatchOptions.Initializer"></a>',id:"initializer--31",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--47",level:4},{value:'<code>pullRequestDescription</code><sup>Required</sup> <a name="pullRequestDescription" id="projen.github.PullRequestFromPatchOptions.property.pullRequestDescription"></a>',id:"pullrequestdescriptionrequired--1",level:5},{value:'<code>pullRequestTitle</code><sup>Required</sup> <a name="pullRequestTitle" id="projen.github.PullRequestFromPatchOptions.property.pullRequestTitle"></a>',id:"pullrequesttitlerequired--1",level:5},{value:'<code>workflowName</code><sup>Required</sup> <a name="workflowName" id="projen.github.PullRequestFromPatchOptions.property.workflowName"></a>',id:"workflownamerequired--1",level:5},{value:'<code>addPaths</code><sup>Optional</sup> <a name="addPaths" id="projen.github.PullRequestFromPatchOptions.property.addPaths"></a>',id:"addpathsoptional--1",level:5},{value:'<code>assignees</code><sup>Optional</sup> <a name="assignees" id="projen.github.PullRequestFromPatchOptions.property.assignees"></a>',id:"assigneesoptional--2",level:5},{value:'<code>baseBranch</code><sup>Optional</sup> <a name="baseBranch" id="projen.github.PullRequestFromPatchOptions.property.baseBranch"></a>',id:"basebranchoptional--1",level:5},{value:'<code>branchName</code><sup>Optional</sup> <a name="branchName" id="projen.github.PullRequestFromPatchOptions.property.branchName"></a>',id:"branchnameoptional--1",level:5},{value:'<code>credentials</code><sup>Optional</sup> <a name="credentials" id="projen.github.PullRequestFromPatchOptions.property.credentials"></a>',id:"credentialsoptional--1",level:5},{value:'<code>deleteBranch</code><sup>Optional</sup> <a name="deleteBranch" id="projen.github.PullRequestFromPatchOptions.property.deleteBranch"></a>',id:"deletebranchoptional--1",level:5},{value:'<code>gitIdentity</code><sup>Optional</sup> <a name="gitIdentity" id="projen.github.PullRequestFromPatchOptions.property.gitIdentity"></a>',id:"gitidentityoptional--1",level:5},{value:'<code>labels</code><sup>Optional</sup> <a name="labels" id="projen.github.PullRequestFromPatchOptions.property.labels"></a>',id:"labelsoptional--3",level:5},{value:'<code>signoff</code><sup>Optional</sup> <a name="signoff" id="projen.github.PullRequestFromPatchOptions.property.signoff"></a>',id:"signoffoptional--1",level:5},{value:'<code>stepId</code><sup>Optional</sup> <a name="stepId" id="projen.github.PullRequestFromPatchOptions.property.stepId"></a>',id:"stepidoptional--1",level:5},{value:'<code>stepName</code><sup>Optional</sup> <a name="stepName" id="projen.github.PullRequestFromPatchOptions.property.stepName"></a>',id:"stepnameoptional--1",level:5},{value:'<code>patch</code><sup>Required</sup> <a name="patch" id="projen.github.PullRequestFromPatchOptions.property.patch"></a>',id:"patchrequired--2",level:5},{value:'<code>jobName</code><sup>Optional</sup> <a name="jobName" id="projen.github.PullRequestFromPatchOptions.property.jobName"></a>',id:"jobnameoptional-",level:5},{value:'<code>runsOn</code><sup>Optional</sup> <a name="runsOn" id="projen.github.PullRequestFromPatchOptions.property.runsOn"></a>',id:"runsonoptional--5",level:5},{value:'<code>runsOnGroup</code><sup>Optional</sup> <a name="runsOnGroup" id="projen.github.PullRequestFromPatchOptions.property.runsOnGroup"></a>',id:"runsongroupoptional--5",level:5},{value:'PullRequestLintOptions <a name="PullRequestLintOptions" id="projen.github.PullRequestLintOptions"></a>',id:"pullrequestlintoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.PullRequestLintOptions.Initializer"></a>',id:"initializer--32",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--48",level:4},{value:'<code>runsOn</code><sup>Optional</sup> <a name="runsOn" id="projen.github.PullRequestLintOptions.property.runsOn"></a>',id:"runsonoptional--6",level:5},{value:'<code>runsOnGroup</code><sup>Optional</sup> <a name="runsOnGroup" id="projen.github.PullRequestLintOptions.property.runsOnGroup"></a>',id:"runsongroupoptional--6",level:5},{value:'<code>contributorStatement</code><sup>Optional</sup> <a name="contributorStatement" id="projen.github.PullRequestLintOptions.property.contributorStatement"></a>',id:"contributorstatementoptional-",level:5},{value:'<code>contributorStatementOptions</code><sup>Optional</sup> <a name="contributorStatementOptions" id="projen.github.PullRequestLintOptions.property.contributorStatementOptions"></a>',id:"contributorstatementoptionsoptional-",level:5},{value:'<code>semanticTitle</code><sup>Optional</sup> <a name="semanticTitle" id="projen.github.PullRequestLintOptions.property.semanticTitle"></a>',id:"semantictitleoptional-",level:5},{value:'<code>semanticTitleOptions</code><sup>Optional</sup> <a name="semanticTitleOptions" id="projen.github.PullRequestLintOptions.property.semanticTitleOptions"></a>',id:"semantictitleoptionsoptional-",level:5},{value:'PullRequestPatchSource <a name="PullRequestPatchSource" id="projen.github.PullRequestPatchSource"></a>',id:"pullrequestpatchsource-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.PullRequestPatchSource.Initializer"></a>',id:"initializer--33",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--49",level:4},{value:'<code>fetchDepth</code><sup>Optional</sup> <a name="fetchDepth" id="projen.github.PullRequestPatchSource.property.fetchDepth"></a>',id:"fetchdepthoptional--2",level:5},{value:'<code>lfs</code><sup>Optional</sup> <a name="lfs" id="projen.github.PullRequestPatchSource.property.lfs"></a>',id:"lfsoptional--2",level:5},{value:'<code>path</code><sup>Optional</sup> <a name="path" id="projen.github.PullRequestPatchSource.property.path"></a>',id:"pathoptional--3",level:5},{value:'<code>ref</code><sup>Optional</sup> <a name="ref" id="projen.github.PullRequestPatchSource.property.ref"></a>',id:"refoptional--2",level:5},{value:'<code>repository</code><sup>Optional</sup> <a name="repository" id="projen.github.PullRequestPatchSource.property.repository"></a>',id:"repositoryoptional--3",level:5},{value:'<code>submodules</code><sup>Optional</sup> <a name="submodules" id="projen.github.PullRequestPatchSource.property.submodules"></a>',id:"submodulesoptional--2",level:5},{value:'<code>token</code><sup>Optional</sup> <a name="token" id="projen.github.PullRequestPatchSource.property.token"></a>',id:"tokenoptional--4",level:5},{value:'<code>patchFile</code><sup>Optional</sup> <a name="patchFile" id="projen.github.PullRequestPatchSource.property.patchFile"></a>',id:"patchfileoptional--1",level:5},{value:'<code>jobId</code><sup>Required</sup> <a name="jobId" id="projen.github.PullRequestPatchSource.property.jobId"></a>',id:"jobidrequired--15",level:5},{value:'<code>outputName</code><sup>Required</sup> <a name="outputName" id="projen.github.PullRequestPatchSource.property.outputName"></a>',id:"outputnamerequired-",level:5},{value:'PullRequestTemplateOptions <a name="PullRequestTemplateOptions" id="projen.github.PullRequestTemplateOptions"></a>',id:"pullrequesttemplateoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.PullRequestTemplateOptions.Initializer"></a>',id:"initializer--34",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--50",level:4},{value:'<code>lines</code><sup>Optional</sup> <a name="lines" id="projen.github.PullRequestTemplateOptions.property.lines"></a>',id:"linesoptional-",level:5},{value:'SemanticTitleOptions <a name="SemanticTitleOptions" id="projen.github.SemanticTitleOptions"></a>',id:"semantictitleoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.SemanticTitleOptions.Initializer"></a>',id:"initializer--35",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--51",level:4},{value:'<code>requireScope</code><sup>Optional</sup> <a name="requireScope" id="projen.github.SemanticTitleOptions.property.requireScope"></a>',id:"requirescopeoptional-",level:5},{value:'<code>scopes</code><sup>Optional</sup> <a name="scopes" id="projen.github.SemanticTitleOptions.property.scopes"></a>',id:"scopesoptional-",level:5},{value:'<code>types</code><sup>Optional</sup> <a name="types" id="projen.github.SemanticTitleOptions.property.types"></a>',id:"typesoptional-",level:5},{value:'SetupGitIdentityOptions <a name="SetupGitIdentityOptions" id="projen.github.SetupGitIdentityOptions"></a>',id:"setupgitidentityoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.SetupGitIdentityOptions.Initializer"></a>',id:"initializer--36",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--52",level:4},{value:'<code>env</code><sup>Optional</sup> <a name="env" id="projen.github.SetupGitIdentityOptions.property.env"></a>',id:"envoptional--6",level:5},{value:'<code>id</code><sup>Optional</sup> <a name="id" id="projen.github.SetupGitIdentityOptions.property.id"></a>',id:"idoptional--2",level:5},{value:'<code>if</code><sup>Optional</sup> <a name="if" id="projen.github.SetupGitIdentityOptions.property.if"></a>',id:"ifoptional--3",level:5},{value:'<code>name</code><sup>Optional</sup> <a name="name" id="projen.github.SetupGitIdentityOptions.property.name"></a>',id:"nameoptional--4",level:5},{value:'<code>shell</code><sup>Optional</sup> <a name="shell" id="projen.github.SetupGitIdentityOptions.property.shell"></a>',id:"shelloptional--2",level:5},{value:'<code>workingDirectory</code><sup>Optional</sup> <a name="workingDirectory" id="projen.github.SetupGitIdentityOptions.property.workingDirectory"></a>',id:"workingdirectoryoptional--2",level:5},{value:'<code>background</code><sup>Optional</sup> <a name="background" id="projen.github.SetupGitIdentityOptions.property.background"></a>',id:"backgroundoptional--2",level:5},{value:'<code>cancel</code><sup>Optional</sup> <a name="cancel" id="projen.github.SetupGitIdentityOptions.property.cancel"></a>',id:"canceloptional--2",level:5},{value:'<code>continueOnError</code><sup>Optional</sup> <a name="continueOnError" id="projen.github.SetupGitIdentityOptions.property.continueOnError"></a>',id:"continueonerroroptional--3",level:5},{value:'<code>parallel</code><sup>Optional</sup> <a name="parallel" id="projen.github.SetupGitIdentityOptions.property.parallel"></a>',id:"paralleloptional--2",level:5},{value:'<code>timeoutMinutes</code><sup>Optional</sup> <a name="timeoutMinutes" id="projen.github.SetupGitIdentityOptions.property.timeoutMinutes"></a>',id:"timeoutminutesoptional--3",level:5},{value:'<code>wait</code><sup>Optional</sup> <a name="wait" id="projen.github.SetupGitIdentityOptions.property.wait"></a>',id:"waitoptional--2",level:5},{value:'<code>waitAll</code><sup>Optional</sup> <a name="waitAll" id="projen.github.SetupGitIdentityOptions.property.waitAll"></a>',id:"waitalloptional--2",level:5},{value:'<code>gitIdentity</code><sup>Required</sup> <a name="gitIdentity" id="projen.github.SetupGitIdentityOptions.property.gitIdentity"></a>',id:"gitidentityrequired-",level:5},{value:'StaleBehavior <a name="StaleBehavior" id="projen.github.StaleBehavior"></a>',id:"stalebehavior-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.StaleBehavior.Initializer"></a>',id:"initializer--37",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--53",level:4},{value:'<code>closeMessage</code><sup>Optional</sup> <a name="closeMessage" id="projen.github.StaleBehavior.property.closeMessage"></a>',id:"closemessageoptional-",level:5},{value:'<code>daysBeforeClose</code><sup>Optional</sup> <a name="daysBeforeClose" id="projen.github.StaleBehavior.property.daysBeforeClose"></a>',id:"daysbeforecloseoptional-",level:5},{value:'<code>daysBeforeStale</code><sup>Optional</sup> <a name="daysBeforeStale" id="projen.github.StaleBehavior.property.daysBeforeStale"></a>',id:"daysbeforestaleoptional-",level:5},{value:'<code>enabled</code><sup>Optional</sup> <a name="enabled" id="projen.github.StaleBehavior.property.enabled"></a>',id:"enabledoptional-",level:5},{value:'<code>exemptLabels</code><sup>Optional</sup> <a name="exemptLabels" id="projen.github.StaleBehavior.property.exemptLabels"></a>',id:"exemptlabelsoptional--1",level:5},{value:'<code>staleLabel</code><sup>Optional</sup> <a name="staleLabel" id="projen.github.StaleBehavior.property.staleLabel"></a>',id:"stalelabeloptional-",level:5},{value:'<code>staleMessage</code><sup>Optional</sup> <a name="staleMessage" id="projen.github.StaleBehavior.property.staleMessage"></a>',id:"stalemessageoptional-",level:5},{value:'StaleOptions <a name="StaleOptions" id="projen.github.StaleOptions"></a>',id:"staleoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.StaleOptions.Initializer"></a>',id:"initializer--38",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--54",level:4},{value:'<code>runsOn</code><sup>Optional</sup> <a name="runsOn" id="projen.github.StaleOptions.property.runsOn"></a>',id:"runsonoptional--7",level:5},{value:'<code>runsOnGroup</code><sup>Optional</sup> <a name="runsOnGroup" id="projen.github.StaleOptions.property.runsOnGroup"></a>',id:"runsongroupoptional--7",level:5},{value:'<code>issues</code><sup>Optional</sup> <a name="issues" id="projen.github.StaleOptions.property.issues"></a>',id:"issuesoptional-",level:5},{value:'<code>pullRequest</code><sup>Optional</sup> <a name="pullRequest" id="projen.github.StaleOptions.property.pullRequest"></a>',id:"pullrequestoptional-",level:5},{value:'TaskWorkflowJobOptions <a name="TaskWorkflowJobOptions" id="projen.github.TaskWorkflowJobOptions"></a>',id:"taskworkflowjoboptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.TaskWorkflowJobOptions.Initializer"></a>',id:"initializer--39",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--55",level:4},{value:'<code>permissions</code><sup>Required</sup> <a name="permissions" id="projen.github.TaskWorkflowJobOptions.property.permissions"></a>',id:"permissionsrequired--1",level:5},{value:'<code>artifactsDirectory</code><sup>Optional</sup> <a name="artifactsDirectory" id="projen.github.TaskWorkflowJobOptions.property.artifactsDirectory"></a>',id:"artifactsdirectoryoptional--1",level:5},{value:'<code>checkoutSubmodules</code><sup>Optional</sup> <a name="checkoutSubmodules" id="projen.github.TaskWorkflowJobOptions.property.checkoutSubmodules"></a>',id:"checkoutsubmodulesoptional--1",level:5},{value:'<code>checkoutWith</code><sup>Optional</sup> <a name="checkoutWith" id="projen.github.TaskWorkflowJobOptions.property.checkoutWith"></a>',id:"checkoutwithoptional-",level:5},{value:'<code>condition</code><sup>Optional</sup> <a name="condition" id="projen.github.TaskWorkflowJobOptions.property.condition"></a>',id:"conditionoptional-",level:5},{value:'<code>container</code><sup>Optional</sup> <a name="container" id="projen.github.TaskWorkflowJobOptions.property.container"></a>',id:"containeroptional--1",level:5},{value:'<code>downloadL

1fs</code><sup>Optional</sup> <a name="downloadLfs" id="projen.github.TaskWorkflowJobOptions.property.downloadLfs"></a>',id:"downloadlfsoptional--1",level:5},{value:'<code>env</code><sup>Optional</sup> <a name="env" id="projen.github.TaskWorkflowJobOptions.property.env"></a>',id:"envoptional--7",level:5},{value:'<code>environment</code><sup>Optional</sup> <a name="environment" id="projen.github.TaskWorkflowJobOptions.property.environment"></a>',id:"environmentoptional--3",level:5},{value:'<code>gitIdentity</code><sup>Optional</sup> <a name="gitIdentity" id="projen.github.TaskWorkflowJobOptions.property.gitIdentity"></a>',id:"gitidentityoptional--2",level:5},{value:'<code>jobDefaults</code><sup>Optional</sup> <a name="jobDefaults" id="projen.github.TaskWorkflowJobOptions.property.jobDefaults"></a>',id:"jobdefaultsoptional-",level:5},{value:'<code>outputs</code><sup>Optional</sup> <a name="outputs" id="projen.github.TaskWorkflowJobOptions.property.outputs"></a>',id:"outputsoptional--1",level:5},{value:'<code>postBuildSteps</code><sup>Optional</sup> <a name="postBuildSteps" id="projen.github.TaskWorkflowJobOptions.property.postBuildSteps"></a>',id:"postbuildstepsoptional-",level:5},{value:'<code>preBuildSteps</code><sup>Optional</sup> <a name="preBuildSteps" id="projen.github.TaskWorkflowJobOptions.property.preBuildSteps"></a>',id:"prebuildstepsoptional-",level:5},{value:'<code>preCheckoutSteps</code><sup>Optional</sup> <a name="preCheckoutSteps" id="projen.github.TaskWorkflowJobOptions.property.preCheckoutSteps"></a>',id:"precheckoutstepsoptional-",level:5},{value:'<code>runsOn</code><sup>Optional</sup> <a name="runsOn" id="projen.github.TaskWorkflowJobOptions.property.runsOn"></a>',id:"runsonoptional--8",level:5},{value:'<code>runsOnGroup</code><sup>Optional</sup> <a name="runsOnGroup" id="projen.github.TaskWorkflowJobOptions.property.runsOnGroup"></a>',id:"runsongroupoptional--8",level:5},{value:'TaskWorkflowOptions <a name="TaskWorkflowOptions" id="projen.github.TaskWorkflowOptions"></a>',id:"taskworkflowoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.TaskWorkflowOptions.Initializer"></a>',id:"initializer--40",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--56",level:4},{value:'<code>permissions</code><sup>Required</sup> <a name="permissions" id="projen.github.TaskWorkflowOptions.property.permissions"></a>',id:"permissionsrequired--2",level:5},{value:'<code>artifactsDirectory</code><sup>Optional</sup> <a name="artifactsDirectory" id="projen.github.TaskWorkflowOptions.property.artifactsDirectory"></a>',id:"artifactsdirectoryoptional--2",level:5},{value:'<code>checkoutSubmodules</code><sup>Optional</sup> <a name="checkoutSubmodules" id="projen.github.TaskWorkflowOptions.property.checkoutSubmodules"></a>',id:"checkoutsubmodulesoptional--2",level:5},{value:'<code>checkoutWith</code><sup>Optional</sup> <a name="checkoutWith" id="projen.github.TaskWorkflowOptions.property.checkoutWith"></a>',id:"checkoutwithoptional--1",level:5},{value:'<code>condition</code><sup>Optional</sup> <a name="condition" id="projen.github.TaskWorkflowOptions.property.condition"></a>',id:"conditionoptional--1",level:5},{value:'<code>container</code><sup>Optional</sup> <a name="container" id="projen.github.TaskWorkflowOptions.property.container"></a>',id:"containeroptional--2",level:5},{value:'<code>downloadLfs</code><sup>Optional</sup> <a name="downloadLfs" id="projen.github.TaskWorkflowOptions.property.downloadLfs"></a>',id:"downloadlfsoptional--2",level:5},{value:'<code>env</code><sup>Optional</sup> <a name="env" id="projen.github.TaskWorkflowOptions.property.env"></a>',id:"envoptional--8",level:5},{value:'<code>environment</code><sup>Optional</sup> <a name="environment" id="projen.github.TaskWorkflowOptions.property.environment"></a>',id:"environmentoptional--4",level:5},{value:'<code>gitIdentity</code><sup>Optional</sup> <a name="gitIdentity" id="projen.github.TaskWorkflowOptions.property.gitIdentity"></a>',id:"gitidentityoptional--3",level:5},{value:'<code>jobDefaults</code><sup>Optional</sup> <a name="jobDefaults" id="projen.github.TaskWorkflowOptions.property.jobDefaults"></a>',id:"jobdefaultsoptional--1",level:5},{value:'<code>outputs</code><sup>Optional</sup> <a name="outputs" id="projen.github.TaskWorkflowOptions.property.outputs"></a>',id:"outputsoptional--2",level:5},{value:'<code>postBuildSteps</code><sup>Optional</sup> <a name="postBuildSteps" id="projen.github.TaskWorkflowOptions.property.postBuildSteps"></a>',id:"postbuildstepsoptional--1",level:5},{value:'<code>preBuildSteps</code><sup>Optional</sup> <a name="preBuildSteps" id="projen.github.TaskWorkflowOptions.property.preBuildSteps"></a>',id:"prebuildstepsoptional--1",level:5},{value:'<code>preCheckoutSteps</code><sup>Optional</sup> <a name="preCheckoutSteps" id="projen.github.TaskWorkflowOptions.property.preCheckoutSteps"></a>',id:"precheckoutstepsoptional--1",level:5},{value:'<code>runsOn</code><sup>Optional</sup> <a name="runsOn" id="projen.github.TaskWorkflowOptions.property.runsOn"></a>',id:"runsonoptional--9",level:5},{value:'<code>runsOnGroup</code><sup>Optional</sup> <a name="runsOnGroup" id="projen.github.TaskWorkflowOptions.property.runsOnGroup"></a>',id:"runsongroupoptional--9",level:5},{value:'<code>name</code><sup>Required</sup> <a name="name" id="projen.github.TaskWorkflowOptions.property.name"></a>',id:"namerequired--12",level:5},{value:'<code>task</code><sup>Required</sup> <a name="task" id="projen.github.TaskWorkflowOptions.property.task"></a>',id:"taskrequired--2",level:5},{value:'<code>jobId</code><sup>Optional</sup> <a name="jobId" id="projen.github.TaskWorkflowOptions.property.jobId"></a>',id:"jobidoptional-",level:5},{value:'<code>triggers</code><sup>Optional</sup> <a name="triggers" id="projen.github.TaskWorkflowOptions.property.triggers"></a>',id:"triggersoptional-",level:5},{value:'UploadArtifactOptions <a name="UploadArtifactOptions" id="projen.github.UploadArtifactOptions"></a>',id:"uploadartifactoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.UploadArtifactOptions.Initializer"></a>',id:"initializer--41",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--57",level:4},{value:'<code>env</code><sup>Optional</sup> <a name="env" id="projen.github.UploadArtifactOptions.property.env"></a>',id:"envoptional--9",level:5},{value:'<code>id</code><sup>Optional</sup> <a name="id" id="projen.github.UploadArtifactOptions.property.id"></a>',id:"idoptional--3",level:5},{value:'<code>if</code><sup>Optional</sup> <a name="if" id="projen.github.UploadArtifactOptions.property.if"></a>',id:"ifoptional--4",level:5},{value:'<code>name</code><sup>Optional</sup> <a name="name" id="projen.github.UploadArtifactOptions.property.name"></a>',id:"nameoptional--5",level:5},{value:'<code>shell</code><sup>Optional</sup> <a name="shell" id="projen.github.UploadArtifactOptions.property.shell"></a>',id:"shelloptional--3",level:5},{value:'<code>workingDirectory</code><sup>Optional</sup> <a name="workingDirectory" id="projen.github.UploadArtifactOptions.property.workingDirectory"></a>',id:"workingdirectoryoptional--3",level:5},{value:'<code>background</code><sup>Optional</sup> <a name="background" id="projen.github.UploadArtifactOptions.property.background"></a>',id:"backgroundoptional--3",level:5},{value:'<code>cancel</code><sup>Optional</sup> <a name="cancel" id="projen.github.UploadArtifactOptions.property.cancel"></a>',id:"canceloptional--3",level:5},{value:'<code>continueOnError</code><sup>Optional</sup> <a name="continueOnError" id="projen.github.UploadArtifactOptions.property.continueOnError"></a>',id:"continueonerroroptional--4",level:5},{value:'<code>parallel</code><sup>Optional</sup> <a name="parallel" id="projen.github.UploadArtifactOptions.property.parallel"></a>',id:"paralleloptional--3",level:5},{value:'<code>timeoutMinutes</code><sup>Optional</sup> <a name="timeoutMinutes" id="projen.github.UploadArtifactOptions.property.timeoutMinutes"></a>',id:"timeoutminutesoptional--4",level:5},{value:'<code>wait</code><sup>Optional</sup> <a name="wait" id="projen.github.UploadArtifactOptions.property.wait"></a>',id:"waitoptional--3",level:5},{value:'<code>waitAll</code><sup>Optional</sup> <a name="waitAll" id="projen.github.UploadArtifactOptions.property.waitAll"></a>',id:"waitalloptional--3",level:5},{value:'<code>with</code><sup>Required</sup> <a name="with" id="projen.github.UploadArtifactOptions.property.with"></a>',id:"withrequired--1",level:5},{value:'UploadArtifactWith <a name="UploadArtifactWith" id="projen.github.UploadArtifactWith"></a>',id:"uploadartifactwith-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.UploadArtifactWith.Initializer"></a>',id:"initializer--42",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--58",level:4},{value:'<code>path</code><sup>Required</sup> <a name="path" id="projen.github.UploadArtifactWith.property.path"></a>',id:"pathrequired--1",level:5},{value:'<code>compressionLevel</code><sup>Optional</sup> <a name="compressionLevel" id="projen.github.UploadArtifactWith.property.compressionLevel"></a>',id:"compressionleveloptional-",level:5},{value:'<code>ifNoFilesFound</code><sup>Optional</sup> <a name="ifNoFilesFound" id="projen.github.UploadArtifactWith.property.ifNoFilesFound"></a>',id:"ifnofilesfoundoptional-",level:5},{value:'<code>includeHiddenFiles</code><sup>Optional</sup> <a name="includeHiddenFiles" id="projen.github.UploadArtifactWith.property.includeHiddenFiles"></a>',id:"includehiddenfilesoptional-",level:5},{value:'<code>name</code><sup>Optional</sup> <a name="name" id="projen.github.UploadArtifactWith.property.name"></a>',id:"nameoptional--6",level:5},{value:'<code>overwrite</code><sup>Optional</sup> <a name="overwrite" id="projen.github.UploadArtifactWith.property.overwrite"></a>

1',id:"overwriteoptional-",level:5},{value:'<code>retentionDays</code><sup>Optional</sup> <a name="retentionDays" id="projen.github.UploadArtifactWith.property.retentionDays"></a>',id:"retentiondaysoptional-",level:5},{value:'UploadGitPatchOptions <a name="UploadGitPatchOptions" id="projen.github.UploadGitPatchOptions"></a>',id:"uploadgitpatchoptions-",level:3},{value:'Initializer <a name="Initializer" id="projen.github.UploadGitPatchOptions.Initializer"></a>',id:"initializer--43",level:4},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--59",level:4},{value:'<code>outputName</code><sup>Required</sup> <a name="outputName" id="projen.github.UploadGitPatchOptions.property.outputName"></a>',id:"outputnamerequired--1",level:5},{value:'<code>stepId</code><sup>Required</sup> <a name="stepId" id="projen.github.UploadGitPatchOptions.property.stepId"></a>',id:"stepidrequired--8",level:5},{value:'<code>mutationError</code><sup>Optional</sup> <a name="mutationError" id="projen.github.UploadGitPatchOptions.property.mutationError"></a>',id:"mutationerroroptional-",level:5},{value:'<code>patchFile</code><sup>Optional</sup> <a name="patchFile" id="projen.github.UploadGitPatchOptions.property.patchFile"></a>',id:"patchfileoptional--2",level:5},{value:'<code>stepName</code><sup>Optional</sup> <a name="stepName" id="projen.github.UploadGitPatchOptions.property.stepName"></a>',id:"stepnameoptional--2",level:5},{value:'Classes <a name="Classes" id="Classes"></a>',id:"classes-",level:2},{value:'ActionRefs <a name="ActionRefs" id="projen.github.ActionRefs"></a>',id:"actionrefs-",level:3},{value:'Constants <a name="Constants" id="Constants"></a>',id:"constants--1",level:4},{value:'<code>ACTIONS_CHECKOUT</code><sup>Required</sup> <a name="ACTIONS_CHECKOUT" id="projen.github.ActionRefs.property.ACTIONS_CHECKOUT"></a>',id:"actions_checkoutrequired-",level:5},{value:'<code>ACTIONS_CREATE_GITHUB_APP_TOKEN</code><sup>Required</sup> <a name="ACTIONS_CREATE_GITHUB_APP_TOKEN" id="projen.github.ActionRefs.property.ACTIONS_CREATE_GITHUB_APP_TOKEN"></a>',id:"actions_create_github_app_tokenrequired-",level:5},{value:'<code>ACTIONS_DEPENDENCY_REVIEW_ACTION</code><sup>Required</sup> <a name="ACTIONS_DEPENDENCY_REVIEW_ACTION" id="projen.github.ActionRefs.property.ACTIONS_DEPENDENCY_REVIEW_ACTION"></a>',id:"actions_dependency_review_actionrequired-",level:5},{value:'<code>ACTIONS_DOWNLOAD_ARTIFACT</code><sup>Required</sup> <a name="ACTIONS_DOWNLOAD_ARTIFACT" id="projen.github.ActionRefs.property.ACTIONS_DOWNLOAD_ARTIFACT"></a>',id:"actions_download_artifactrequired-",level:5},{value:'<code>ACTIONS_GITHUB_SCRIPT</code><sup>Required</sup> <a name="ACTIONS_GITHUB_SCRIPT" id="projen.github.ActionRefs.property.ACTIONS_GITHUB_SCRIPT"></a>',id:"actions_github_scriptrequired-",level:5},{value:'<code>ACTIONS_SETUP_DOTNET</code><sup>Required</sup> <a name="ACTIONS_SETUP_DOTNET" id="projen.github.ActionRefs.property.ACTIONS_SETUP_DOTNET"></a>',id:"actions_setup_dotnetrequired-",level:5},{value:'<code>ACTIONS_SETUP_GO</code><sup>Required</sup> <a name="ACTIONS_SETUP_GO" id="projen.github.ActionRefs.property.ACTIONS_SETUP_GO"></a>',id:"actions_setup_gorequired-",level:5},{value:'<code>ACTIONS_SETUP_JAVA</code><sup>Required</sup> <a name="ACTIONS_SETUP_JAVA" id="projen.github.ActionRefs.property.ACTIONS_SETUP_JAVA"></a>',id:"actions_setup_javarequired-",level:5},{value:'<code>ACTIONS_SETUP_NODE</code><sup>Required</sup> <a name="ACTIONS_SETUP_NODE" id="projen.github.ActionRefs.property.ACTIONS_SETUP_NODE"></a>',id:"actions_setup_noderequired-",level:5},{value:'<code>ACTIONS_SETUP_PYTHON</code><sup>Required</sup> <a name="ACTIONS_SETUP_PYTHON" id="projen.github.ActionRefs.property.ACTIONS_SETUP_PYTHON"></a>',id:"actions_setup_pythonrequired-",level:5},{value:'<code>ACTIONS_STALE</code><sup>Required</sup> <a name="ACTIONS_STALE" id="projen.github.ActionRefs.property.ACTIONS_STALE"></a>',id:"actions_stalerequired-",level:5},{value:'<code>ACTIONS_UPLOAD_ARTIFACT</code><sup>Required</sup> <a name="ACTIONS_UPLOAD_ARTIFACT" id="projen.github.ActionRefs.property.ACTIONS_UPLOAD_ARTIFACT"></a>',id:"actions_upload_artifactrequired-",level:5},{value:'<code>AMANNN_ACTION_SEMANTIC_PULL_REQUEST</code><sup>Required</sup> <a name="AMANNN_ACTION_SEMANTIC_PULL_REQUEST" id="projen.github.ActionRefs.property.AMANNN_ACTION_SEMANTIC_PULL_REQUEST"></a>',id:"amannn_action_semantic_pull_requestrequired-",level:5},{value:'<code>AWS_ACTIONS_CONFIGURE_AWS_CREDENTIALS</code><sup>Required</sup> <a name="AWS_ACTIONS_CONFIGURE_AWS_CREDENTIALS" id="projen.github.ActionRefs.property.AWS_ACTIONS_CONFIGURE_AWS_CREDENTIALS"></a>',id:"aws_actions_configure_aws_credentialsrequired-",level:5},{value:'<code>CODECOV_CODECOV_ACTION</code><sup>Required</sup> <a name="CODECOV_CODECOV_ACTION" id="projen.github.ActionRefs.property.CODECOV_CODECOV_ACTION"></a>',id:"codecov_codecov_actionrequired-",level:5},{value:'<code>OVEN_SH_SETUP_BUN</code><sup>Required</sup> <a name="OVEN_SH_SETUP_BUN" id="projen.github.ActionRefs.property.OVEN_SH_SETUP_BUN"></a>',id:"oven_sh_setup_bunrequired-",level:5},{value:'<code>PETER_EVANS_CREATE_PULL_REQUEST</code><sup>Required</sup> <a name="PETER_EVANS_CREATE_PULL_REQUEST" id="projen.github.ActionRefs.property.PETER_EVANS_CREATE_PULL_REQUEST"></a>',id:"peter_evans_create_pull_requestrequired-",level:5},{value:'<code>

1PNPM_ACTION_SETUP</code><sup>Required</sup> <a name="PNPM_ACTION_SETUP" id="projen.github.ActionRefs.property.PNPM_ACTION_SETUP"></a>',id:"pnpm_action_setuprequired-",level:5},{value:'<code>SQREN_BACKPORT_GITHUB_ACTION</code><sup>Required</sup> <a name="SQREN_BACKPORT_GITHUB_ACTION" id="projen.github.ActionRefs.property.SQREN_BACKPORT_GITHUB_ACTION"></a>',id:"sqren_backport_github_actionrequired-",level:5},{value:'GitHubActionsProvider <a name="GitHubActionsProvider" id="projen.github.GitHubActionsProvider"></a>',id:"githubactionsprovider-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.GitHubActionsProvider.Initializer"></a>',id:"initializers--16",level:4},{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--16",level:4},{value:'<code>get</code> <a name="get" id="projen.github.GitHubActionsProvider.get"></a>',id:"get-",level:5},{value:'<code>action</code><sup>Required</sup> <a name="action" id="projen.github.GitHubActionsProvider.get.parameter.action"></a>',id:"actionrequired-",level:6},{value:'<code>set</code> <a name="set" id="projen.github.GitHubActionsProvider.set"></a>',id:"set-",level:5},{value:'<code>action</code><sup>Required</sup> <a name="action" id="projen.github.GitHubActionsProvider.set.parameter.action"></a>',id:"actionrequired--1",level:6},{value:'<code>override</code><sup>Required</sup> <a name="override" id="projen.github.GitHubActionsProvider.set.parameter.override"></a>',id:"overriderequired-",level:6},{value:'GithubCredentials <a name="GithubCredentials" id="projen.github.GithubCredentials"></a>',id:"githubcredentials-",level:3},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--16",level:4},{value:'<code>fromApp</code> <a name="fromApp" id="projen.github.GithubCredentials.fromApp"></a>',id:"fromapp-",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.GithubCredentials.fromApp.parameter.options"></a>',id:"optionsoptional--15",level:6},{value:'<code>fromPersonalAccessToken</code> <a name="fromPersonalAccessToken" id="projen.github.GithubCredentials.fromPersonalAccessToken"></a>',id:"frompersonalaccesstoken-",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.GithubCredentials.fromPersonalAccessToken.parameter.options"></a>',id:"optionsoptional--16",level:6},{value:'Properties <a name="Properties" id="Properties"></a>',id:"properties--60",level:4},{value:'<code>setupSteps</code><sup>Required</sup> <a name="setupSteps" id="projen.github.GithubCredentials.property.setupSteps"></a>',id:"setupstepsrequired-",level:5},{value:'<code>tokenRef</code><sup>Required</sup> <a name="tokenRef" id="projen.github.GithubCredentials.property.tokenRef"></a>',id:"tokenrefrequired-",level:5},{value:'<code>environment</code><sup>Optional</sup> <a name="environment" id="projen.github.GithubCredentials.property.environment"></a>',id:"environmentoptional--5",level:5},{value:'WorkflowActions <a name="WorkflowActions" id="projen.github.WorkflowActions"></a>',id:"workflowactions-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.WorkflowActions.Initializer"></a>',id:"initializers--17",level:4},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--17",level:4},{value:'<code>checkoutWithPatch</code> <a name="checkoutWithPatch" id="projen.github.WorkflowActions.checkoutWithPatch"></a>',id:"checkoutwithpatch-",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.WorkflowActions.checkoutWithPatch.parameter.options"></a>',id:"optionsoptional--17",level:6},{value:'<code>createPullRequest</code> <a name="createPullRequest" id="projen.github.WorkflowActions.createPullRequest"></a>',id:"createpullrequest-",level:5},{value:'<code>options</code><sup>Required</sup> <a name="options" id="projen.github.WorkflowActions.createPullRequest.parameter.options"></a>',id:"optionsrequired--3",level:6},{value:'<code>uploadGitPatch</code> <a name="uploadGitPatch" id="projen.github.WorkflowActions.uploadGitPatch"></a>',id:"uploadgitpatch-",level:5},{value:'<code>options</code><sup>Required</sup> <a name="options" id="projen.github.WorkflowActions.uploadGitPatch.parameter.options"></a>',id:"optionsrequired--4",level:6},{value:'WorkflowJobs <a name="WorkflowJobs" id="projen.github.WorkflowJobs"></a>',id:"workflowjobs-",level:3}

1,{value:'Initializers <a name="Initializers" id="projen.github.WorkflowJobs.Initializer"></a>',id:"initializers--18",level:4},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--18",level:4},{value:'<code>pullRequestFromPatch</code> <a name="pullRequestFromPatch" id="projen.github.WorkflowJobs.pullRequestFromPatch"></a>',id:"pullrequestfrompatch-",level:5},{value:'<code>options</code><sup>Required</sup> <a name="options" id="projen.github.WorkflowJobs.pullRequestFromPatch.parameter.options"></a>',id:"optionsrequired--5",level:6},{value:'WorkflowSteps <a name="WorkflowSteps" id="projen.github.WorkflowSteps"></a>',id:"workflowsteps-",level:3},{value:'Initializers <a name="Initializers" id="projen.github.WorkflowSteps.Initializer"></a>',id:"initializers--19",level:4},{value:'Static Functions <a name="Static Functions" id="Static Functions"></a>',id:"static-functions--19",level:4},{value:'<code>checkout</code> <a name="checkout" id="projen.github.WorkflowSteps.checkout"></a>',id:"checkout-",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.WorkflowSteps.checkout.parameter.options"></a>',id:"optionsoptional--18",level:6},{value:'<code>downloadArtifact</code> <a name="downloadArtifact" id="projen.github.WorkflowSteps.downloadArtifact"></a>',id:"downloadartifact-",level:5},{value:'<code>options</code><sup>Optional</sup> <a name="options" id="projen.github.WorkflowSteps.downloadArtifact.parameter.options"></a>',id:"optionsoptional--19",level:6},{value:'<code>setupGitIdentity</code> <a name="setupGitIdentity" id="projen.github.WorkflowSteps.setupGitIdentity"></a>',id:"setupgitidentity-",level:5},{value:'<code>options</code><sup>Required</sup> <a name="options" id="projen.github.WorkflowSteps.setupGitIdentity.parameter.options"></a>',id:"optionsrequired--6",level:6},{value:'<code>tagExists</code> <a name="tagExists" id="projen.github.WorkflowSteps.tagExists"></a>',id:"tagexists-",level:5},{value:'<code>tag</code><sup>Required</sup> <a name="tag" id="projen.github.WorkflowSteps.tagExists.parameter.tag"></a>',id:"tagrequired-",level:6},{value:'<code>options</code><sup>Required</sup> <a name="options" id="projen.github.WorkflowSteps.tagExists.parameter.options"></a>',id:"optionsrequired--7",level:6},{value:'<code>uploadArtifact</code> <a name="uploadArtifact" id="projen.github.WorkflowSteps.uploadArtifact"></a>',id:"uploadartifact-",level:5},{value:'<code>options</code><sup>Required</sup> <a name="options" id="projen.github.WorkflowSteps.uploadArtifact.parameter.options"></a>',id:"optionsrequired--8",level:6},{value:'Protocols <a name="Protocols" id="Protocols"></a>',id:"protocols-",level:2},{value:'IAddConditionsLater <a name="IAddConditionsLater" id="projen.github.IAddConditionsLater"></a>',id:"iaddconditionslater-",level:3}

1,{value:'Methods <a name="Methods" id="Methods"></a>',id:"methods--17",level:4},{value:'<code>render</code> <a name="render" id="projen.github.IAddConditionsLater.render"></a>',id:"render-",level:5},{value:'Enums <a name="Enums" id="Enums"></a>',id:"enums-",level:2},{value:'CheckoutSubmodules <a name="CheckoutSubmodules" id="projen.github.CheckoutSubmodules"></a>',id:"checkoutsubmodules-",level:3},{value:'Members <a name="Members" id="Members"></a>',id:"members-",level:4},{value:'<code>DISABLED</code> <a name="DISABLED" id="projen.github.CheckoutSubmodules.DISABLED"></a>',id:"disabled-",level:5},{value:'<code>ENABLED</code> <a name="ENABLED" id="projen.github.CheckoutSubmodules.ENABLED"></a>',id:"enabled-",level:5},{value:'<code>RECURSIVE</code> <a name="RECURSIVE" id="projen.github.CheckoutSubmodules.RECURSIVE"></a>',id:"recursive-",level:5},{value:'DependabotGroupAppliesTo <a name="DependabotGroupAppliesTo" id="projen.github.DependabotGroupAppliesTo"></a>',id:"dependabotgroupappliesto-",level:3},{value:'Members <a name="Members" id="Members"></a>',id:"members--1",level:4},{value:'<code>VERSION_UPDATES</code> <a name="VERSION_UPDATES" id="projen.github.DependabotGroupAppliesTo.VERSION_UPDATES"></a>',id:"version_updates-",level:5},{value:'<code>SECURITY_UPDATES</code> <a name="SECURITY_UPDATES" id="projen.github.DependabotGroupAppliesTo.SECURITY_UPDATES"></a>',id:"security_updates-",level:5},{value:'DependabotGroupDependencyType <a name="DependabotGroupDependencyType" id="projen.github.DependabotGroupDependencyType"></a>',id:"dependabotgroupdependencytype-",level:3},{value:'Members <a name="Members" id="Members"></a>',id:"members--2",level:4},{value:'<code>DEVELOPMENT</code> <a name="DEVELOPMENT" id="projen.github.DependabotGroupDependencyType.DEVELOPMENT"></a>',id:"development-",level:5},{value:'<code>PRODUCTION</code> <a name="PRODUCTION" id="projen.github.DependabotGroupDependencyType.PRODUCTION"></a>',id:"production-",level:5},{value:'DependabotGroupUpdateType <a name="DependabotGroupUpdateType" id="projen.github.DependabotGroupUpdateType"></a>',id:"dependabotgroupupdatetype-",level:3},{value:'Members <a name="Members" id="Members"></a>',id:"members--3",level:4},{value:'<code>MAJOR</code> <a name="MAJOR" id="projen.github.DependabotGroupUpdateType.MAJOR"></a>',id:"major-",level:5},{value:'<code>MINOR</code> <a name="MINOR" id="projen.github.DependabotGroupUpdateType.MINOR"></a>',id:"minor-",level:5},{value:'<code>PATCH</code> <a name="PATCH" id="projen.github.DependabotGroupUpdateType.PATCH"></a>',id:"patch-",level:5},{value:'DependabotRegistryType <a name="DependabotRegistryType" id="projen.github.DependabotRegistryType"></a>',id:"dependabotregistrytype-",level:3},{value:'Members <a name="Members" id="Members"></a>',id:"members--4",level:4},{value:'<code>COMPOSER_REGISTRY</code> <a name="COMPOSER_REGISTRY" id="projen.github.DependabotRegistryType.COMPOSER_REGISTRY"></a>',id:"composer_registry-",level:5},{value:'<code>DOCKER_REGISTRY</code> <a name="DOCKER_REGISTRY" id="projen.github.DependabotRegistryType.DOCKER_REGISTRY"></a>',id:"docker_registry-",level:5},{value:'<code>GIT</code> <a name="GIT" id="projen.github.DependabotRegistryType.GIT"></a>',id:"git-",level:5},{value:'<code>HEX_ORGANIZATION</code> <a name="HEX_ORGANIZATION" id="projen.github.DependabotRegistryType.HEX_ORGANIZATION"></a>',id:"hex_organization-",level:5},{value:'<code>MAVEN_REPOSITORY</code> <a name="MAVEN_REPOSITORY" id="projen.github.DependabotRegistryType.MAVEN_REPOSITORY"></a>',id:"maven_repository-",level:5},{value:'<code>NPM_REGISTRY</code> <a name="NPM_REGISTRY" id="projen.github.DependabotRegistryType.NPM_REGISTRY"></a>',id:"npm_registry-",level:5},{value:'<code>NUGET_FEED</code> <a name="NUGET_FEED" id="projen.github.DependabotRegistryType.NUGET_FEED"></a>',id:"nuget_feed-",level:5},{value:'<code>PYTHON_INDEX</code> <a name="PYTHON_INDEX" id="projen.github.DependabotRegistryType.PYTHON_INDEX"></a>',id:"python_index-",level:5},{value:'<code>RUBYGEMS_SERVER</code> <a name="RUBYGEMS_SERVER" id="projen.github.DependabotRegistryType.RUBYGEMS_SERVER"></a>',id:"rubygems_server-",level:5},{value:'<code>TERRAFORM_REGISTRY</code> <a name="TERRAFORM_REGISTRY" id="projen.github.DependabotRegistryType.TERRAFORM_REGISTRY"></a>',id:"terraform_registry-",level:5},{value:'DependabotScheduleInterval <a name="DependabotScheduleInterval" id="projen.github.DependabotScheduleInterval"></a>',id:"dependabotscheduleinterval-",level:3},{value:'Members <a name="Members" id="Members"></a>',id:"members--5",level:4},{value:'<code>DAILY</code> <a name="DAILY" id="projen.github.DependabotScheduleInterval.DAILY"></a>',id:"daily-",level:5},{value:'<code>WEEKLY</code> <a name="WEEKLY" id="projen.github.DependabotScheduleInterval.WEEKLY"></a>',id:"weekly-",level:5},{value:'<code>MONTHLY</code> <a name="MONTHLY" id="projen.github.DependabotScheduleInterval.MONTHLY"></a>',id:"monthly-",level:5},{value:'MergeMethod <a name="MergeMethod" id="projen.github.MergeMethod"></a>',id:"mergemethod-",level:3},{value:'Members <a name="Members" id="Members"></a>',id:"members--6",level:4},{value:'<code>SQUASH</code> <a name="SQUASH" id="projen.github.MergeMethod.SQUASH"></a>',id:"squash-",level:5},{value:'<code>MERGE</code> <a name="MERGE" id="projen.github.MergeMethod.MERGE"></a>',id:"merge-",level:5},{value:'<code>REBASE</code> <a name="REBASE" id="projen.github.MergeMethod.REBASE"></a>',id:"rebase-",level:5},{value:'VersioningStrategy <a name="VersioningStrategy" id="projen.github.VersioningStrategy"></a>',id:"versioningstrategy-",level:3},{value:'Members <a name="Members" id="Members"></a>',id:"members--7",level:4},{value:'<code>LOCKFILE_ONLY</code> <a name="LOCKFILE_ONLY" id="projen.github.VersioningStrategy.LOCKFILE_ONLY"></a>',id:"lockfile_only-",level:5},{value:'<code>AUTO</code> <a name="AUTO" id="projen.github.VersioningStrategy.AUTO"></a>',id:"auto-",level:5},{value:'<code>WIDEN</code> <a name="WIDEN" id="projen.github.VersioningStrategy.WIDEN"></a>',id:"widen-",level:5},{value:'<code>INCREASE</code> <a name="INCREASE" id="projen.github.VersioningStrategy.INCREASE"></a>',id:"increase-",level:5},{value:'<code>INCREASE_IF_NECESSARY</code> <a name="INCREASE_IF_NECESSARY" id="projen.github.VersioningStrategy.INCREASE_IF_NECESSARY"></a>',id:"increase_if_necessary-",level:5}];function h(e){let n={a:"a",blockquote:"blockquote",code:"code",del:"del",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h

15:"h5",h6:"h6",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",sup:"sup",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsxs)(n.h1,{id:"github-submodule-",children:[(0,s.jsx)(n.code,{children:"github"})," Submodule ",(0,s.jsx)(n.a,{name:"`github` Submodule",id:"projen.github"})]})}),"\n",(0,s.jsxs)(n.h2,{id:"constructs-",children:["Constructs ",(0,s.jsx)(n.a,{name:"Constructs",id:"Constructs"})]}),"\n",(0,s.jsxs)(n.h3,{id:"autoapprove-",children:["AutoApprove ",(0,s.jsx)(n.a,{name:"AutoApprove",id:"projen.github.AutoApprove"})]}),"\n",(0,s.jsx)(n.p,{children:"Auto approve pull requests that meet a criteria."}),"\n",(0,s.jsxs)(n.h4,{id:"initializers-",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.AutoApprove.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.AutoApprove(github: GitHub, options?: AutoApproveOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.Initializer.parameter.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApproveOptions",children:"AutoApproveOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githubrequired-",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.AutoApprove.Initializer.parameter.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional-",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.AutoApprove.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.AutoApproveOptions",children:"AutoApproveOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods-",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.

1synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring-",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.AutoApprove.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with-",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.AutoApprove.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired-",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.AutoApprove.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation-",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.AutoApprove.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired-",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.AutoApprove.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize-",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.AutoApprove.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize-",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.AutoApprove.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation-",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.AutoApprove.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--1",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.AutoApprove.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize-",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.AutoApprove.

1synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions-",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct-",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.AutoApprove.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.AutoApprove.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired-",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.AutoApprove.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent-",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.AutoApprove.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.AutoApprove.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--1",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.AutoApprove.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties-",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove.property.label",children:"label"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired-",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.AutoApprove.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired-",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.AutoApprove.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"labelrequired-",children:[(0,s.jsx)(n.code,{children:"label"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"label",id:"projen.github.AutoApprove.property.label"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly label: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"automerge-",children:["AutoMerge ",(0,s.jsx)(n.a,{name:"AutoMerge",id:"projen.github.AutoMerge"})]}),"\n",(0,s.jsx)(n.p,{children:"Automatically merge Pull Requests using Mergify."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:["[!NOTE]\nGitHub now natively provides the same features, so you don't need Mergify\nanymore. See ",(0,s.jsx)(n.code,{children:"GitHubOptions.mergeQueue"})," and ",(0,s.jsx)(n.code,{children:"MergeQueueOptions.autoQueue"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["If ",(0,s.jsx)(n.code,{children:"buildJob"})," is specified, the specified GitHub workflow job ID is required\nto succeed in order for the PR to be merged."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"approvedReviews"})," specified the number of code review approvals required for\nthe PR to be merged."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://mergify.com/",children:"https://mergify.com/"})}),"\n"]}

1),"\n",(0,s.jsxs)(n.h4,{id:"initializers--1",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.AutoMerge.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.AutoMerge(github: GitHub, options?: AutoMergeOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.Initializer.parameter.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMergeOptions",children:"AutoMergeOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githubrequired--1",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.AutoMerge.Initializer.parameter.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--1",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.AutoMerge.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.AutoMergeOptions",children:"AutoMergeOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--1",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.

1synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.addConditions",children:"addConditions"})})}),(0,s.jsx)(n.td,{children:"Adds conditions to the auto merge rule."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.addConditionsLater",children:"addConditionsLater"})})}),(0,s.jsx)(n.td,{children:"Adds conditions that will be rendered only during synthesis."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--1",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.AutoMerge.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--1",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.AutoMerge.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--1",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.AutoMerge.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--1",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.AutoMerge.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--2",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.AutoMerge.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--1",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.AutoMerge.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--1",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.AutoMerge.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--1",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.AutoMerge.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--3",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.AutoMerge.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--1",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.AutoMerge.

1synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h5,{id:"addconditions-",children:[(0,s.jsx)(n.code,{children:"addConditions"})," ",(0,s.jsx)(n.a,{name:"addConditions",id:"projen.github.AutoMerge.addConditions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addConditions(conditions: ...string[]): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Adds conditions to the auto merge rule."}),"\n",(0,s.jsxs)(n.h6,{id:"conditionsrequired-",children:[(0,s.jsx)(n.code,{children:"conditions"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"conditions",id:"projen.github.AutoMerge.addConditions.parameter.conditions"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The conditions to add (mergify syntax)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addconditionslater-",children:[(0,s.jsx)(n.code,{children:"addConditionsLater"})," ",(0,s.jsx)(n.a,{name:"addConditionsLater",id:"projen.github.AutoMerge.addConditionsLater"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addConditionsLater(later: IAddConditionsLater): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Adds conditions that will be rendered only during synthesis."}),"\n",(0,s.jsxs)(n.h6,{id:"laterrequired-",children:[(0,s.jsx)(n.code,{children:"later"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"later",id:"projen.github.AutoMerge.addConditionsLater.parameter.later"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.IAddConditionsLater",children:"IAddConditionsLater"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The later."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--1",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--1",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.AutoMerge.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.AutoMerge.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--2",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.AutoMerge.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--1",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.AutoMerge.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.AutoMerge.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--3",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.AutoMerge.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--1",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMerge.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--1",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.AutoMerge.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--1",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.AutoMerge.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"autoqueue-",children:["AutoQueue ",(0,s.jsx)(n.a,{name:"AutoQueue",id:"projen.github.AutoQueue"})]}),"\n",(0,s.jsx)(n.p,{children:"Automatically add pull requests to the merge queue PRs will be merged once they pass required checks."}

1),"\n",(0,s.jsxs)(n.h4,{id:"initializers--2",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.AutoQueue.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.AutoQueue(scope: IConstruct, options?: AutoQueueOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.Initializer.parameter.scope",children:"scope"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.IConstruct"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions",children:"AutoQueueOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"scoperequired-",children:[(0,s.jsx)(n.code,{children:"scope"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"scope",id:"projen.github.AutoQueue.Initializer.parameter.scope"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.IConstruct"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--2",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.AutoQueue.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions",children:"AutoQueueOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--2",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--2",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.AutoQueue.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--2",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.AutoQueue.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--2",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.AutoQueue.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--2",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.AutoQueue.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--4",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.AutoQueue.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--2",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.AutoQueue.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--2",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.AutoQueue.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--2",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.AutoQueue.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--5",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.AutoQueue.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--2",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.AutoQueue.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--2",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--2",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.AutoQueue.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.AutoQueue.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--4",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.AutoQueue.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--2",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.AutoQueue.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.AutoQueue.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--5",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.AutoQueue.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--2",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueue.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--2",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.AutoQueue.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--2",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.AutoQueue.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.j

1sxs)(n.h3,{id:"dependabot-",children:["Dependabot ",(0,s.jsx)(n.a,{name:"Dependabot",id:"projen.github.Dependabot"})]}),"\n",(0,s.jsx)(n.p,{children:"Defines dependabot configuration for node projects."}),"\n",(0,s.jsx)(n.p,{children:'Since module versions are managed in projen, the versioning strategy will be\nconfigured to "lockfile-only" which means that only updates that can be done\non the lockfile itself will be proposed.'}),"\n",(0,s.jsxs)(n.h4,{id:"initializers--3",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.Dependabot.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.Dependabot(github: GitHub, options?: DependabotOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.Initializer.parameter.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions",children:"DependabotOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githubrequired--2",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.Dependabot.Initializer.parameter.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--3",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.Dependabot.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions",children:"DependabotOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--3",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.addAllow",children:"addAllow"})})}),(0,s.jsx)(n.td,{children:"Allows a dependency from automatic updates."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.addIgnore",children:"addIgnore"})})}),(0,s.jsx)(n.td,{children:"Ignores a dependency from automatic updates."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--3",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.Dependabot.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--3",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.Dependabot.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--3",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.Dependabot.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--3",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.Dependabot.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--6",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.Dependabot.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--3",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.Dependabot.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--3",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.Dependabot.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--3",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.Dependabot.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--7",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.Dependabot.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--3",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.Dependabot.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h5,{id:"addallow-",children:[(0,s.jsx)(n.code,{children:"addAllow"})," ",(0,s.jsx)(n.a,{name:"addAllow",id:"projen.github.Dependabot.addAllow"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addAllow(dependencyName: string): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Allows a dependency from automatic updates."}),"\n",(0,s.jsxs)(n.h6,{id:"dependencynamerequired-",children:[(0,s.jsx)(n.code,{children:"dependencyName"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"dependencyName",id:"projen.github.Dependabot.addAllow.parameter.dependencyName"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Use to allow updates for dependencies with matching names, optionally using ",(0,s.jsx)(n.code,{children:"*"})," to match zero or more characters."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addignore-",children:[(0,s.jsx)(n.code,{children:"addIgnore"})," ",(0,s.jsx)(n.a,{name:"addIgnore",id:"projen.github.Dependabot.addIgnore"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addIgnore(dependencyName: string, versions: ...string[]): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Ignores a dependency from automatic updates."}),"\n",(0,s.jsxs)(n.h6,{id:"dependencynamerequired--1",children:[(0,s.jsx)(n.code,{children:"dependencyName"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"dependencyName",id:"projen.github.Dependabot.addIgnore.parameter.dependencyName"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Use to ignore updates for dependencies with matching names, optionally using ",(0,s.jsx)(n.code,{children:"*"})," to match zero or more characters."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"versionsrequired-",children:[(0,s.jsx)(n.code,{children:"versions"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"versions",id:"projen.github.Dependabot.addIgnore.parameter.versions"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Use to ignore specific versions or ranges of versions."}),"\n",(0,s.jsxs)(n.p,{children:["If\nyou want to define a range, use the standard pattern for the package\nmanager (for example: ",(0,s.jsx)(n.code,{children:"^1.0.0"})," for npm, or ",(0,s.jsx)(n.code,{children:"~> 2.0"})," for Bundler)."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--3",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--3",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.Dependabot.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.Dependabot.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may ma

1nually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--6",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.Dependabot.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--3",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.Dependabot.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.Dependabot.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--7",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.Dependabot.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--3",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.property.config",children:"config"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"any"})}),(0,s.jsx)(n.td,{children:"The raw dependabot configuration."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Dependabot.property.ignoresProjen",children:"ignoresProjen"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether or not projen is also upgraded in this config,."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--3",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.Dependabot.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--3",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.Dependabot.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"configrequired-",children:[(0,s.jsx)(n.code,{children:"config"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"config",id:"projen.github.Dependabot.property.config"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly config: any;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The raw dependabot configuration."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates",children:"https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"ignoresprojenrequired-",children:[(0,s.jsx)(n.code,{children:"ignoresProjen"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ignoresProjen",id:"projen.github.Dependabot.property.ignoresProjen"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ignoresProjen: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not projen is also upgraded in this config,."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependencyreview-",children:["DependencyReview ",(0,s.jsx)(n.a,{name:"DependencyReview",id:"projen.github.DependencyReview"})]}),"\n",(0,s.jsx)(n.p,{children:"Adds a GitHub workflow that runs the dependency-review-action on pull requests."}),"\n",(0,s.jsx)(n.p,{children:"This action scans pull requests for dependency changes and raises an error\nif any vulnerabilities or invalid licenses are introduced."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/actions/dependency-review-action",children:"https://github.com/actions/dependency-review-action"})}),"\n"]}

1),"\n",(0,s.jsxs)(n.h4,{id:"initializers--4",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.DependencyReview.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.DependencyReview(github: GitHub, options?: DependencyReviewOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.Initializer.parameter.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions",children:"DependencyReviewOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githubrequired--3",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.DependencyReview.Initializer.parameter.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--4",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.DependencyReview.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions",children:"DependencyReviewOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--4",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--4",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.DependencyReview.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--4",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.DependencyReview.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--4",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.DependencyReview.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--4",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.DependencyReview.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--8",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.DependencyReview.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--4",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.DependencyReview.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--4",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.DependencyReview.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--4",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.DependencyReview.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--9",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.DependencyReview.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--4",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.DependencyReview.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--4",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--4",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.DependencyReview.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.DependencyReview.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--8",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.DependencyReview.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--4",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.DependencyReview.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.DependencyReview.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--9",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.DependencyReview.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--4",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReview.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--4",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.DependencyReview.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--4",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{

1name:"project",id:"projen.github.DependencyReview.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"github-",children:["GitHub ",(0,s.jsx)(n.a,{name:"GitHub",id:"projen.github.GitHub"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializers--5",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.GitHub.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.GitHub(project: Project, options?: GitHubOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.Initializer.parameter.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions",children:"GitHubOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--5",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.GitHub.Initializer.parameter.project"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--5",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.GitHub.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions",children:"GitHubOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--5",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.addDependabot",children:"addDependabot"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.addPullRequestTemplate",children:"addPullRequestTemplate"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.addWorkflow",children:"addWorkflow"})})}),(0,s.jsx)(n.td,{children:"Adds a workflow to the project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.runsOnConfig",children:"runsOnConfig"})})}),(0,s.jsxs)(n.td,{children:["Resolves the ",(0,s.jsx)(n.code,{children:"runsOn"}),"/",(0,s.jsx)(n.code,{children:"runsOnGroup"})," config for a job, falling back to the project's global runner selection (",(0,s.jsx)(n.code,{children:"workflowRunsOn"}),"/",(0,s.jsx)(n.code,{children:"workflowRunsOnGroup"}),") when ",(0,s.jsx)(n.code,{children:"options"})," does not specify one."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.tryFindWorkflow",children:"tryFindWorkflow"})})}),(0,s.jsx)(n.td,{children:"Finds a GitHub workflow by name."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--5",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.GitHub.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--5",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.GitHub.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--5",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.GitHub.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--5",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.GitHub.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--10",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.GitHub.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--5",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.GitHub.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--5",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.GitHub.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--5",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.GitHub.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--11",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.GitHub.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--5",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.GitHub.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h5,{id:"adddependabot-",children:[(0,s.jsx)(n.code,{children:"addDependabot"})," ",(0,s.jsx)(n.a,{name:"addDependabot",id:"projen.github.GitHub.addDependabot"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addDependabot(options?: DependabotOptions): Depen

1dabot\n"})}),"\n",(0,s.jsxs)(n.h6,{id:"optionsoptional--6",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.GitHub.addDependabot.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions",children:"DependabotOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addpullrequesttemplate-",children:[(0,s.jsx)(n.code,{children:"addPullRequestTemplate"})," ",(0,s.jsx)(n.a,{name:"addPullRequestTemplate",id:"projen.github.GitHub.addPullRequestTemplate"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addPullRequestTemplate(content: ...string[]): PullRequestTemplate\n"})}),"\n",(0,s.jsxs)(n.h6,{id:"contentrequired-",children:[(0,s.jsx)(n.code,{children:"content"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"content",id:"projen.github.GitHub.addPullRequestTemplate.parameter.content"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addworkflow-",children:[(0,s.jsx)(n.code,{children:"addWorkflow"})," ",(0,s.jsx)(n.a,{name:"addWorkflow",id:"projen.github.GitHub.addWorkflow"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addWorkflow(name: string): GithubWorkflow\n"})}),"\n",(0,s.jsx)(n.p,{children:"Adds a workflow to the project."}),"\n",(0,s.jsxs)(n.h6,{id:"namerequired-",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.GitHub.addWorkflow.parameter.name"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Name of the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonconfig-",children:[(0,s.jsx)(n.code,{children:"runsOnConfig"})," ",(0,s.jsx)(n.a,{name:"runsOnConfig",id:"projen.github.GitHub.runsOnConfig"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public runsOnConfig(options?: RunsOnOptions): RunsOnConfig\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Resolves the ",(0,s.jsx)(n.code,{children:"runsOn"}),"/",(0,s.jsx)(n.code,{children:"runsOnGroup"})," config for a job, falling back to the project's global runner selection (",(0,s.jsx)(n.code,{children:"workflowRunsOn"}),"/",(0,s.jsx)(n.code,{children:"workflowRunsOnGroup"}),") when ",(0,s.jsx)(n.code,{children:"options"})," does not specify one."]}),"\n",(0,s.jsxs)(n.h6,{id:"optionsoptional--7",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.GitHub.runsOnConfig.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.RunsOnOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"per-job runner selection that takes precedence over the project's global default."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tryfindworkflow-",children:[(0,s.jsx)(n.code,{children:"tryFindWorkflow"})," ",(0,s.jsx)(n.a,{name:"tryFindWorkflow",id:"projen.github.GitHub.tryFindWorkflow"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public tryFindWorkflow(name: string): GithubWorkflow\n"})}),"\n",(0,s.jsx)(n.p,{children:"Finds a GitHub workflow by name."}),"\n",(0,s.jsxs)(n.p,{children:["Returns ",(0,s.jsx)(n.code,{children:"undefined"})," if the workflow cannot be found."]}),"\n",(0,s.jsxs)(n.h6,{id:"namerequired--1",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.GitHub.tryFindWorkflow.parameter.name"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the GitHub workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--5",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.of",children:"of"})})}),(0,s.jsxs)(n.td,{children:["Returns the ",(0,s.jsx)(n.code,{children:"GitHub"})," component of a project or ",(0,s.jsx)(n.code,{children:"undefined"})," if the project does not have a GitHub component."]})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--5",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.GitHub.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.GitHub.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--10",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.GitHub.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--5",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.GitHub.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.GitHub.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--11",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.GitHub.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"of-",children:[(0,s.jsx)(n.code,{children:"of"})," ",(0,s.jsx)(n.a,{name:"of",id:"projen.github.GitHub.of"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.GitHub.of(project: Project)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns the ",(0,s.jsx)(n.code,{children:"GitHub"})," component of a project or ",(0,s.jsx)(n.code,{children:"undefined"})," if the project does not have a GitHub component."]}),"\n",(0,s.jsxs)(n.h6,{id:"projectrequired--6",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.GitHub.of.parameter.project"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--5",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.property.actions",children:"actions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubActionsProvider",children:"GitHubActionsProvider"})})}),(0,s.jsx)(n.td,{children:"The GitHub Actions provider used to manage the versions of actions used in steps."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.property.checkoutSubmodules",children:"checkoutSubmodules"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})})}),(0,s.jsx)(n.td,{children:"Whether checking out Git submodules is enabled for this GitHub project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.property.downloadLfs",children:"downloadLfs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether downloading from LFS is enabled for this GitHub project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.property.projenCredentials",children:"projenCredentials"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})})}),(0,s.jsx)(n.td,{children:"GitHub API authentication method used by projen workflows."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.property.workflows",children:"workflows"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow",children:"GithubWorkflow"}),"[]"]})}),(0,s.jsx)(n.td,{children:"All workflows."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.property.workflowsEnabled",children:"workflowsEnabled"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Are workflows enabled?"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.property.mergeQueue",children:"mergeQueue"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue",children:"MergeQueue"})})}),(0,s.jsxs)(n.td,{children:["The ",(0,s.jsx)(n.code,{children:"MergeQueue"})," component configured on this repository This is ",(0,s.jsx)(n.code,{children:"undefined"})," if merge queues are not enabled for this repository."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub.property.mergify",children:"mergify"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify",children:"Mergify"})})}),(0,s.jsxs)(n.td,{children:["The ",(0,s.jsx)(n.code,{children:"Mergify"})," component configured on this repository This is ",(0,s.jsx)(n.code,{children:"undefined"})," if Mergify is not enabled for this repository."]})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--5",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.GitHub.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--7",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.GitHub.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actionsrequired-",children:[(0,s.jsx)(n.code,{children:"actions"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"actions",id:"projen.github.GitHub.property.actions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly actions: GitHubActionsProvider;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHubActionsProvider",children:"GitHubActionsProvider"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The GitHub Actions provider used to manage the versions of actions used in steps."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"checkoutsubmodulesrequired-",children:[(0,s.jsx)(n.code,{children:"checkoutSubmodules"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"checkoutSubmodules",id:"projen.github.GitHub.property.checkoutSubmodules"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly checkoutSubmodules: CheckoutSubmodules;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether checking out Git submodules is enabled for this GitHub project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"downloadlfsrequired-",children:[(0,s.jsx)(n.code,{children:"downloadLfs"}),(0,s.j

1sx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"downloadLfs",id:"projen.github.GitHub.property.downloadLfs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly downloadLfs: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether downloading from LFS is enabled for this GitHub project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projencredentialsrequired-",children:[(0,s.jsx)(n.code,{children:"projenCredentials"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"projenCredentials",id:"projen.github.GitHub.property.projenCredentials"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projenCredentials: GithubCredentials;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"GitHub API authentication method used by projen workflows."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workflowsrequired-",children:[(0,s.jsx)(n.code,{children:"workflows"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"workflows",id:"projen.github.GitHub.property.workflows"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workflows: GithubWorkflow[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow",children:"GithubWorkflow"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"All workflows."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workflowsenabledrequired-",children:[(0,s.jsx)(n.code,{children:"workflowsEnabled"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"workflowsEnabled",id:"projen.github.GitHub.property.workflowsEnabled"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workflowsEnabled: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Are workflows enabled?"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mergequeueoptional-",children:[(0,s.jsx)(n.code,{children:"mergeQueue"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mergeQueue",id:"projen.github.GitHub.property.mergeQueue"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mergeQueue: MergeQueue;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue",children:"MergeQueue"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"MergeQueue"})," component configured on this repository This is ",(0,s.jsx)(n.code,{children:"undefined"})," if merge queues are not enabled for this repository."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mergifyoptional-",children:[(0,s.jsx)(n.code,{children:"mergify"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mergify",id:"projen.github.GitHub.property.mergify"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mergify: Mergify;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.Mergify",children:"Mergify"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"Mergify"})," component configured on this repository This is ",(0,s.jsx)(n.code,{children:"undefined"})," if Mergify is not enabled for this repository."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"githubproject-",children:["GitHubProject ",(0,s.jsx)(n.a,{name:"GitHubProject",id:"projen.github.GitHubProject"})]}),"\n",(0,s.jsx)(n.p,{children:"GitHub-based project."}

1),"\n",(0,s.jsxs)(n.h4,{id:"initializers--6",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.GitHubProject.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.GitHubProject(options: GitHubProjectOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions",children:"GitHubProjectOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsrequired-",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.GitHubProject.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions",children:"GitHubProjectOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--6",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.addExcludeFromCleanup",children:"addExcludeFromCleanup"})})}),(0,s.jsx)(n.td,{children:"Exclude the matching files from pre-synth cleanup."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.addGitIgnore",children:"addGitIgnore"})})}),(0,s.jsx)(n.td,{children:"Adds a .gitignore pattern."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.addPackageIgnore",children:"addPackageIgnore"})})}),(0,s.jsx)(n.td,{children:"Exclude these files from the bundled package."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.addTask",children:"addTask"})})}),(0,s.jsx)(n.td,{children:"Adds a new task to this project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.annotateGenerated",children:"annotateGenerated"})})}),(0,s.jsx)(n.td,{children:"Marks the provided file(s) as being generated."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after all components are synthesized."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before all components are synthesized."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.removeTask",children:"removeTask"})})}),(0,s.jsx)(n.td,{children:"Removes a task from a project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.runTaskCommand",children:"runTaskCommand"})})}),(0,s.jsx)(n.td,{children:"Returns the shell command to execute in order to run a task."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.synth",children:"synth"})})}),(0,s.jsxs)(n.td,{children:["Synthesize all project files into ",(0,s.jsx)(n.code,{children:"outdir"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.tryFindFile",children:"tryFindFile"})})}),(0,s.jsx)(n.td,{children:"Finds a file at the specified relative path within this project and all its subprojects."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.tryFindObjectFile",children:"tryFindObjectFile"})})}),(0,s.jsx)(n.td,{children:"Finds an object file (like JsonFile, YamlFile, etc.) by n

1ame."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.tryRemoveFile",children:"tryRemoveFile"})})}),(0,s.jsx)(n.td,{children:"Finds a file at the specified relative path within this project and removes it."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--6",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"toString"})})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.GitHubProject.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--6",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"with"})})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.GitHubProject.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--6",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.GitHubProject.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addexcludefromcleanup-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"addExcludeFromCleanup"})})," ",(0,s.jsx)(n.a,{name:"addExcludeFromCleanup",id:"projen.github.GitHubProject.addExcludeFromCleanup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addExcludeFromCleanup(globs: ...string[]): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Exclude the matching files from pre-synth cleanup."}),"\n",(0,s.jsx)(n.p,{children:"Can be used when, for example, some\nsource files include the projen marker and we don't want them to be erased during synth."}),"\n",(0,s.jsxs)(n.h6,{id:"globsrequired-",children:[(0,s.jsx)(n.code,{children:"globs"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"globs",id:"projen.github.GitHubProject.addExcludeFromCleanup.parameter.globs"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The glob patterns to match."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addgitignore-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"addGitIgnore"})})," ",(0,s.jsx)(n.a,{name:"addGitIgnore",id:"projen.github.GitHubProject.addGitIgnore"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addGitIgnore(pattern: string): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Adds a .gitignore pattern."}),"\n",(0,s.jsxs)(n.h6,{id:"patternrequired-",children:[(0,s.jsx)(n.code,{children:"pattern"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"pattern",id:"projen.github.GitHubProject.addGitIgnore.parameter.pattern"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The glob pattern to ignore."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addpackageignore-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"addPackageIgnore"})})," ",(0,s.jsx)(n.a,{name:"addPackageIgnore",id:"projen.github.GitHubProject.addPackageIgnore"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addPackageIgnore(_pattern: string): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Exclude these files from the bundled package."}),"\n",(0,s.jsxs)(n.p,{children:["Implemented by project types based on the\npackaging mechanism. For example, ",(0,s.jsx)(n.code,{children:"NodeProject"})," delegates this to ",(0,s.jsx)(n.code,{children:".npmignore"}),"."]}),"\n",(0,s.jsxs)(n.h6,{id:"_patternrequired-",children:[(0,s.jsx)(n.code,{children:"_pattern"}),(0,s.jsx)(n.sup,{children:"Required"}

1)," ",(0,s.jsx)(n.a,{name:"_pattern",id:"projen.github.GitHubProject.addPackageIgnore.parameter._pattern"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The glob pattern to exclude."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addtask-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"addTask"})})," ",(0,s.jsx)(n.a,{name:"addTask",id:"projen.github.GitHubProject.addTask"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addTask(name: string, props?: TaskOptions): Task\n"})}),"\n",(0,s.jsx)(n.p,{children:"Adds a new task to this project."}),"\n",(0,s.jsx)(n.p,{children:"This will fail if the project already has\na task with this name."}),"\n",(0,s.jsxs)(n.h6,{id:"namerequired--2",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.GitHubProject.addTask.parameter.name"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The task name to add."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"propsoptional-",children:[(0,s.jsx)(n.code,{children:"props"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"props",id:"projen.github.GitHubProject.addTask.parameter.props"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.TaskOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Task properties."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"annotategenerated-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"annotateGenerated"})})," ",(0,s.jsx)(n.a,{name:"annotateGenerated",id:"projen.github.GitHubProject.annotateGenerated"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public annotateGenerated(glob: string): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Marks the provided file(s) as being generated."}),"\n",(0,s.jsx)(n.p,{children:"This is achieved using the\ngithub-linguist attributes. Generated files do not count against the\nrepository statistics and language breakdown."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/github/linguist/blob/master/docs/overrides.md",children:"https://github.com/github/linguist/blob/master/docs/overrides.md"})}),"\n"]}),"\n",(0,s.jsxs)(n.h6,{id:"globrequired-",children:[(0,s.jsx)(n.code,{children:"glob"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"glob",id:"projen.github.GitHubProject.annotateGenerated.parameter.glob"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"the glob pattern to match (could be a file path)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--6",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"postSynthesize"})})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.GitHubProject.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after all components are synthesized."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--6",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"preSynthesize"})})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.GitHubProject.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before all components are synthesized."}),"\n",(0,s.jsxs)(n.h5,{id:"removetask-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"removeTask"})})," ",(0,s.jsx)(n.a,{name:"removeTask",id:"projen.github.GitHubProject.removeTask"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public removeTask(name: string): Task\n"})}),"\n",(0,s.jsx)(n.p,{children:"Removes a task from a project."}),"\n",(0,s.jsxs)(n.h6,{id:"namerequired--3",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.GitHubProject.removeTask.parameter.name"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the task to remove."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runtaskcommand-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"runTaskCommand"})})," ",(0,s.jsx)(n.a,{name:"runTaskCommand",id:"projen.github.GitHubProject.runTaskCommand"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public runTaskCommand(task: Task): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns the shell command to execute in order to run a task."}),"\n",(0,s.jsxs)(n.p,{children:["By default, this is ",(0,s.jsx)(n.code,{children:"npx projen@<version> <task>"})]}),"\n",(0,s.jsxs)(n.h6,{id:"taskrequired-",children:[(0,s.jsx)(n.code,{children:"task"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"task",id:"projen.github.GitHubProject.runTaskCommand.parameter.task"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Task"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The task for which the command is required."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synth-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"synth"})})," ",(0,s.jsx)(n.a,{name:"synth",id:"projen.github.GitHubProject.synth"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synth(): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Synthesize all project files into ",(0,s.jsx)(n.code,{children:"outdir"}),"."]}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:'Call "this.preSynthesize()"'}),"\n",(0,s.jsx)(n.li,{children:"Delete all generated files"}),"\n",(0,s.jsx)(n.li,{children:"Synthesize all subprojects"}),"\n",(0,s.jsx)(n.li,{children:"Synthesize all components of this project"}),"\n",(0,s.jsx)(n.li,{children:'Call "projectCreation()" for all c

1omponents, only if the project is being created for the first time'}),"\n",(0,s.jsx)(n.li,{children:'Call "postSynthesize()" for all components of this project'}),"\n",(0,s.jsx)(n.li,{children:'Call "this.postSynthesize()"'}),"\n",(0,s.jsx)(n.li,{children:'Call "postProjectCreation()" for all components, only if the project is being created for the first time'}),"\n"]}),"\n",(0,s.jsxs)(n.h5,{id:"tryfindfile-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"tryFindFile"})})," ",(0,s.jsx)(n.a,{name:"tryFindFile",id:"projen.github.GitHubProject.tryFindFile"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public tryFindFile(filePath: string): FileBase\n"})}),"\n",(0,s.jsx)(n.p,{children:"Finds a file at the specified relative path within this project and all its subprojects."}),"\n",(0,s.jsxs)(n.h6,{id:"filepathrequired-",children:[(0,s.jsx)(n.code,{children:"filePath"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"filePath",id:"projen.github.GitHubProject.tryFindFile.parameter.filePath"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The file path."}),"\n",(0,s.jsxs)(n.p,{children:["If this path is relative, it will be resolved\nfrom the root of ",(0,s.jsx)(n.em,{children:"this"})," project."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tryfindobjectfile-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"tryFindObjectFile"})})," ",(0,s.jsx)(n.a,{name:"tryFindObjectFile",id:"projen.github.GitHubProject.tryFindObjectFile"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public tryFindObjectFile(filePath: string): ObjectFile\n"})}),"\n",(0,s.jsx)(n.p,{children:"Finds an object file (like JsonFile, YamlFile, etc.) by name."}),"\n",(0,s.jsxs)(n.h6,{id:"filepathrequired--1",children:[(0,s.jsx)(n.code,{children:"filePath"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"filePath",id:"projen.github.GitHubProject.tryFindObjectFile.parameter.filePath"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The file path."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tryremovefile-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"tryRemoveFile"})})," ",(0,s.jsx)(n.a,{name:"tryRemoveFile",id:"projen.github.GitHubProject.tryRemoveFile"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public tryRemoveFile(filePath: string): FileBase\n"})}),"\n",(0,s.jsx)(n.p,{children:"Finds a file at the specified relative path within this project and removes it."}),"\n",(0,s.jsxs)(n.h6,{id:"filepathrequired--2",children:[(0,s.jsx)(n.code,{children:"filePath"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"filePath",id:"projen.github.GitHubProject.tryRemoveFile.parameter.filePath"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The file path."}),"\n",(0,s.jsxs)(n.p,{children:["If this path is relative, it will be\nresolved from the root of ",(0,s.jsx)(n.em,{children:"this"})," project."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--6",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.isProject",children:"isProject"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.of",children:"of"})})}),(0,s.jsx)(n.td,{children:"Find the closest ancestor project for given construct."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--6",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"isConstruct"})})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.GitHubProject.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.GitHubProject.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--12",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.GitHubProject.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isproject-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"isProject"})})," ",(0,s.jsx)(n.a,{name:"isProject",id:"projen.github.GitHubProject.isProject"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.GitHubProject.isProject(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a project."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--13",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.GitHubProject.isProject.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"of--1",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"of"})})," ",(0,s.jsx)(n.a,{name:"of",id:"projen.github.GitHubProject.of"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.GitHubProject.of(construct: IConstruct)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Find the closest ancestor project for given construct."}),"\n",(0,s.jsx)(n.p,{children:"When given a project, this it the project itself."}),"\n",(0,s.jsxs)(n.h6,{id:"constructrequired-",children:[(0,s.jsx)(n.code,{children:"construct"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"construct",id:"projen.github.GitHubProject.of.parameter.construct"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.IConstruct"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--6",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.buildTask",children:"buildTask"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Task"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.commitGenerated",children:"commitGenerated"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether to commit the managed files by default."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.compileTask",children:"compileTask"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Task"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.components",children:"components"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Component[]"})}),(0,s.jsx)(n.td,{children:"Returns all the components within this project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.deps",children:"deps"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Dependencies"})}),(0,s.jsx)(n.td,{children:"Project dependencies."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.ejected",children:"ejected"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether or not the project is being ejected."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.files",children:"files"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.FileBase[]"})}),(0,s.jsx)(n.td,{children:"All files in this project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.gitattributes",children:"gitattributes"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GitAttributesFile"})}),(0,s.jsx)(n.td,{children:"The .gitattributes file for this repository."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.gitignore",children:"gitignore"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.IgnoreFile"})}),(0,s.jsx)(n.td,{children:".gitignore."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.logger",children:"logger"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Logger"})}),(0,s.jsx)(n.td,{children:"Logging utilities."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Project name."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.outdir",children:"outdir"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Absolute output directory of this project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.packageTask",children:"packageTask"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Task"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.postCompileTask",children:"postCompileTask"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Task"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.preCompileTask",children:"preCompileTask"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Task"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.projectBuild",children:"projectBuild"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.ProjectBuild"})}),(0,s.jsx)(n.td,{children:"Manages the build process of the project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.projenCommand",children:"projenCommand"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The command to use in order to run the projen CLI."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.root",children:"root"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:"The root project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.subprojects",children:"subprojects"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project[]"})}),(0,s.jsx)(n.td,{children:"Returns all the subprojects within this project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.tasks",children:"tasks"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Tasks"})}),(0,s.jsx)(n.td,{children:"Project tasks."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.testTask",children:"testTask"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Task"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.defaultTask",children:"defaultTask"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{childre

1n:"projen.Task"})}),(0,s.jsx)(n.td,{children:'This is the "default" task, the one that executes "projen".'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.initProject",children:"initProject"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.InitProject"})}),(0,s.jsxs)(n.td,{children:["The options used when this project is bootstrapped via ",(0,s.jsx)(n.code,{children:"projen new"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.parent",children:"parent"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:"A parent project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.autoApprove",children:"autoApprove"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove",children:"AutoApprove"})})}),(0,s.jsx)(n.td,{children:"Auto approve set up for this project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.devContainer",children:"devContainer"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.vscode.DevContainer"})}),(0,s.jsx)(n.td,{children:"Access for .devcontainer.json (used for GitHub Codespaces)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:"Access all github components."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.gitpod",children:"gitpod"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Gitpod"})}),(0,s.jsx)(n.td,{children:"Access for Gitpod."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.vscode",children:"vscode"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.vscode.VsCode"})}),(0,s.jsx)(n.td,{children:"Access all VSCode components."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--6",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"node"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.GitHubProject.property.node"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"buildtaskrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"buildTask"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"buildTask",id:"projen.github.GitHubProject.property.buildTask"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly buildTask: Task;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Task"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"commitgeneratedrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"commitGenerated"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"commitGenerated",id:"projen.github.GitHubProject.property.commitGenerated"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly commitGenerated: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to commit the managed files by default."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"compiletaskrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"compileTask"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"compileTask",id:"projen.github.GitHubProject.property.compileTask"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly compileTask: Task;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Task"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"componentsrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"components"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"components",id:"projen.github.GitHubProject.property.components"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly components: Component[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Component[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns all the components within this project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"depsrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"deps"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"deps",id:"projen.github.GitHubProject.property.deps"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly deps: Dependencies;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Dependencies"]}

1),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Project dependencies."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"ejectedrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"ejected"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ejected",id:"projen.github.GitHubProject.property.ejected"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ejected: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not the project is being ejected."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"filesrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"files"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"files",id:"projen.github.GitHubProject.property.files"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly files: FileBase[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.FileBase[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"All files in this project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitattributesrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"gitattributes"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"gitattributes",id:"projen.github.GitHubProject.property.gitattributes"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitattributes: GitAttributesFile;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GitAttributesFile"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The .gitattributes file for this repository."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitignorerequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"gitignore"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"gitignore",id:"projen.github.GitHubProject.property.gitignore"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitignore: IgnoreFile;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.IgnoreFile"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:".gitignore."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"loggerrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"logger"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"logger",id:"projen.github.GitHubProject.property.logger"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly logger: Logger;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Logger"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Logging utilities."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"namerequired--4",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"name"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.GitHubProject.property.name"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Project name."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"outdirrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"outdir"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"outdir",id:"projen.github.GitHubProject.property.outdir"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly outdir: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Absolute output directory of this project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"packagetaskrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"packageTask"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"packageTask",id:"projen.github.GitHubProject.property.packageTask"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly packageTask: Task;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Task"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postcompiletaskrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"postCompileTask"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"postCompileTask",id:"projen.github.GitHubProject.property.postCompileTask"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly postCompileTask: Task;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Task"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"precompiletaskrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"preCompileTask"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"preCompileTask",id:"projen.github.GitHubProject.property.preCompileTask"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly preCompileTask: Task;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Task"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectbuildrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"projectBuild"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"projectBuild",id:"projen.github.GitHubProject.property.projectBuild"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projectBuild: ProjectBuild;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.ProjectBuild"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Manages the build process of the project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projencommandrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"projenCommand"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"projenCommand",id:"projen.github.GitHubProject.property.projenCommand"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projenCommand: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The command to use in order to run the projen CLI."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"rootrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"root"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"root",id:"projen.github.GitHubProject.property.root"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly root: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The root project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"subprojectsrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"subprojects"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"subprojects",id:"projen.github.GitHubProject.property.subprojects"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly subprojects: Project[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Returns all the subprojects within this project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tasksrequired-",children:[(0,

1s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"tasks"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"tasks",id:"projen.github.GitHubProject.property.tasks"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly tasks: Tasks;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Tasks"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Project tasks."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"testtaskrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"testTask"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"testTask",id:"projen.github.GitHubProject.property.testTask"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly testTask: Task;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Task"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"defaulttaskoptional-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"defaultTask"})}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"defaultTask",id:"projen.github.GitHubProject.property.defaultTask"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly defaultTask: Task;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Task"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'This is the "default" task, the one that executes "projen".'}),"\n",(0,s.jsx)(n.p,{children:"Undefined if\nthe project is being ejected."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"initprojectoptional-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"initProject"})}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.GitHubProject.property.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," use the ",(0,s.jsx)(n.code,{children:"initProject"})," argument passed to ",(0,s.jsx)(n.code,{children:"Component.projectCreation()"})," instead."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly initProject: InitProject;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The options used when this project is bootstrapped via ",(0,s.jsx)(n.code,{children:"projen new"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"It\nincludes the original set of options passed to the CLI and also the JSII\nFQN of the project type."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"parentoptional-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"parent"})}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"parent",id:"projen.github.GitHubProject.property.parent"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly parent: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A parent project."}),"\n",(0,s.jsx)(n.p,{children:"If undefined, this is the root project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"autoapproveoptional-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"autoApprove"})}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"autoApprove",id:"projen.github.GitHubProject.property.autoApprove"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly autoApprove: AutoApprove;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.AutoApprove",children:"AutoApprove"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Auto approve set up for this project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"devcontaineroptional-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"devContainer"})}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"devContainer",id:"projen.github.GitHubProject.property.devContainer"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly devContainer: DevContainer;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.vscode.DevContainer"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Access for .devcontainer.json (used for GitHub Codespaces)."}),"\n",(0,s.jsxs)(n.p,{children:["This will be ",(0,s.jsx)(n.code,{children:"undefined"})," if devContainer boolean is false"]}

1),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githuboptional-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"github"})}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.GitHubProject.property.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly github: GitHub;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Access all github components."}),"\n",(0,s.jsxs)(n.p,{children:["This will be ",(0,s.jsx)(n.code,{children:"undefined"})," for subprojects."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitpodoptional-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"gitpod"})}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"gitpod",id:"projen.github.GitHubProject.property.gitpod"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitpod: Gitpod;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Gitpod"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Access for Gitpod."}),"\n",(0,s.jsxs)(n.p,{children:["This will be ",(0,s.jsx)(n.code,{children:"undefined"})," if gitpod boolean is false"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"vscodeoptional-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"vscode"})}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"vscode",id:"projen.github.GitHubProject.property.vscode"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly vscode: VsCode;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.vscode.VsCode"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Access all VSCode components."}),"\n",(0,s.jsxs)(n.p,{children:["This will be ",(0,s.jsx)(n.code,{children:"undefined"})," for subprojects."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"constants-",children:["Constants ",(0,s.jsx)(n.a,{name:"Constants",id:"Constants"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProject.property.DEFAULT_TASK",children:"DEFAULT_TASK"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["The name of the default task (the task executed when ",(0,s.jsx)(n.code,{children:"projen"})," is run without arguments)."]})]})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"default_taskrequired-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"DEFAULT_TASK"})}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"DEFAULT_TASK",id:"projen.github.GitHubProject.property.DEFAULT_TASK"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," This is a ",(0,s.jsx)(n.em,{children:"temporary"})," class. At the moment, our base project\ntypes such as ",(0,s.jsx)(n.code,{children:"NodeProject"})," and ",(0,s.jsx)(n.code,{children:"JavaProject"}),' are derived from this, but we\nwant to be able to use these project types outside of GitHub as well. One of\nthe next steps to address this is to abstract workflows so that different\n"engines" can be used to implement our CI/CD solutions.']}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly DEFAULT_TASK: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The name of the default task (the task executed when ",(0,s.jsx)(n.code,{children:"projen"})," is run without arguments)."]}),"\n",(0,s.jsx)(n.p,{children:"Normally\nthis task should synthesize the project files."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"githubworkflow-",children:["GithubWorkflow ",(0,s.jsx)(n.a,{name:"GithubWorkflow",id:"projen.github.GithubWorkflow"})]}),"\n",(0,s.jsx)(n.p,{children:"Workflow for GitHub."}),"\n",(0,s.jsx)(n.p,{children:"A workflow is a configurable automated process made up of one or more jobs."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions",children:"https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions"})}),"\n"]}

1),"\n",(0,s.jsxs)(n.h4,{id:"initializers--7",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.GithubWorkflow.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.GithubWorkflow(github: GitHub, name: string, options?: GithubWorkflowOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.Initializer.parameter.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:"The GitHub component of the project this workflow belongs to."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.Initializer.parameter.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:'The name of the workflow, displayed under the repository\'s "Actions" tab.'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflowOptions",children:"GithubWorkflowOptions"})})}),(0,s.jsx)(n.td,{children:"Additional options to configure the workflow."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githubrequired--4",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.GithubWorkflow.Initializer.parameter.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The GitHub component of the project this workflow belongs to."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"namerequired--5",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.GithubWorkflow.Initializer.parameter.name"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'The name of the workflow, displayed under the repository\'s "Actions" tab.'}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--8",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.GithubWorkflow.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflowOptions",children:"GithubWorkflowOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Additional options to configure the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--7",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.addJob",children:"addJob"})})}),(0,s.jsx)(n.td,{children:"Adds a single job to the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.addJobs",children:"addJobs"})})}),(0,s.jsx)(n.td,{children:"Add jobs to the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.appendStep",children:"appendStep"})})}),(0,s.jsx)(n.td,{children:"Appends a step to the end of a job's step list."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.getJob",children:"getJob"})})}),(0,s.jsx)(n.td,{children:"Get a single job from the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.getStep",children:"getStep"})})}),(0,s.jsx)(n.td,{children:"Gets a single step from a job by step ID."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.insertStepAfter",children:"insertStepAfter"})})}),(0,s.jsx)(n.td,{children:"Inserts a step after an existing step, identified by ID."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.insertStepBefore",children:"insertStepBefore"})})}),(0,s.jsx)(n.td,{children:"Inserts a step before an existing step, identified by ID."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.on",children:"on"})})}),(0,s.jsx)(n.td,{children:"Add events to triggers the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.patchStep",children:"patchStep"})})}),(0,s.jsx)(n.td,{children:"Applies a surgical modification to an existing step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.removeJob",children:"removeJob"})})}),(0,s.jsx)(n.td,{children:"Removes a single job to the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.removeStep",children:"removeStep"})})}),(0,s.jsx)(n.td,{children:"Removes a step from a job by step ID."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.replaceStep",children:"replaceStep"})})}),(0,s.jsx)(n.td,{children:"Replaces an existing step in a job, preserving its position."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.updateJob",children:"updateJob"})})}),(0,s.jsx)(n.td,{children:"Updates a single job to the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.updateJobs",children:"updateJobs"})})}),(0,s.jsx)(n.td,{children:"Updates jobs for this workflow Does a complete replace, it does not try to merge the jobs."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--7",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.GithubWorkflow.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--7",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.GithubWorkflow.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--7",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.GithubWorkflow.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--6",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.GithubWorkflow.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--12",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.GithubWorkflow.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--7",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.GithubWorkflow.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--7",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.GithubWorkflow.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--6",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.GithubWorkflow.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--13",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.GithubWorkflow.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--6",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.GithubWorkflow.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h5,{id:"addjob-",children:[(0,s.jsx)(n.code,{children:"addJob"})," ",(0,s.jsx)(n.a,{name:"addJob",id:"projen.github.GithubWorkflow.addJob"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addJob(id: string, job: JobCallingReusableWorkflow | Job): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Adds a single job to the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"idrequired-",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.GithubWorkflow.addJob.parameter.id"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"jobrequired-",children:[(0,s.jsx)(n.code,{children:"job"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"job",id:"projen.github.GithubWorkflow.addJob.parameter.job"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"}

1)," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job specification."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addjobs-",children:[(0,s.jsx)(n.code,{children:"addJobs"})," ",(0,s.jsx)(n.a,{name:"addJobs",id:"projen.github.GithubWorkflow.addJobs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addJobs(jobs: {[ key: string ]: JobCallingReusableWorkflow | Job}): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Add jobs to the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"jobsrequired-",children:[(0,s.jsx)(n.code,{children:"jobs"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobs",id:"projen.github.GithubWorkflow.addJobs.parameter.jobs"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"}),"}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Jobs to add."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"appendstep-",children:[(0,s.jsx)(n.code,{children:"appendStep"})," ",(0,s.jsx)(n.a,{name:"appendStep",id:"projen.github.GithubWorkflow.appendStep"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public appendStep(jobId: string, step: JobStep): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Appends a step to the end of a job's step list."}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired-",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.GithubWorkflow.appendStep.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"steprequired-",children:[(0,s.jsx)(n.code,{children:"step"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"step",id:"projen.github.GithubWorkflow.appendStep.parameter.step"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step to add."}),"\n",(0,s.jsxs)(n.p,{children:["Must have an ",(0,s.jsx)(n.code,{children:"id"})," set."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"getjob-",children:[(0,s.jsx)(n.code,{children:"getJob"})," ",(0,s.jsx)(n.a,{name:"getJob",id:"projen.github.GithubWorkflow.getJob"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public getJob(id: string): JobCallingReusableWorkflow | Job\n"})}),"\n",(0,s.jsx)(n.p,{children:"Get a single job from the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"idrequired--1",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.GithubWorkflow.getJob.parameter.id"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"getstep-",children:[(0,s.jsx)(n.code,{children:"getStep"})," ",(0,s.jsx)(n.a,{name:"getStep",id:"projen.github.GithubWorkflow.getStep"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public getStep(jobId: string, stepId: string): JobStep\n"})}),"\n",(0,s.jsx)(n.p,{children:"Gets a single step from a job by step ID."}),"\n",(0,s.jsxs)(n.p,{children:["The returned object is frozen and read-only. Use ",(0,s.jsx)(n.code,{children:"replaceStep"})," or\n",(0,s.jsx)(n.code,{children:"patchStep"})," to modify a step."]}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--1",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.GithubWorkflow.getStep.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"stepidrequired-",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.GithubWorkflow.getStep.parameter.stepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step ID to look up."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"insertstepafter-",children:[(0,s.jsx)(n.code,{children:"insertStepAfter"})," ",(0,s.jsx)(n.a,{name:"insertStepAfter",id:"projen.github.GithubWorkflow.insertStepAfter"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public insertStepAfter(jobId: string, referenceStepId: string, step: JobStep): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Inserts a step after an existing step, identified by ID."}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--2",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.GithubWorkflow.insertStepAfter.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"referencestepidrequired-",children:[(0,s.jsx)(n.code,{children:"referenceStepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"referenceStepId",id:"projen.github.GithubWorkflow.insertStepAfter.parameter.referenceStepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the step to insert after."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"steprequired--1",children:[(0,s.jsx)(n.code,{children:"step"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"step",id:"projen.github.GithubWorkflow.insertStepAfter.parameter.step"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step to insert."}),"\n",(0,s.jsxs)(n.p,{children:["Must have an ",(0,s.jsx)(n.code,{children:"id"})," set."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"insertstepbefore-",children:[(0,s.jsx)(n.code,{children:"insertStepBefore"})," ",(0,s.jsx)(n.a,{name:"insertStepBefore",id:"projen.github.GithubWorkflow.insertStepBefore"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public insertStepBefore(jobId: string, referenceStepId: string, step: JobStep): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Inserts a step before an existing step, identified by ID."}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--3",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.GithubWorkflow.insertStepBefore.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"referencestepidrequired--1",children:[(0,s.jsx)(n.code,{children:"referenceStepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"referenceStepId",id:"projen.github.GithubWorkflow.insertStepBefore.parameter.referenceStepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the step to insert before."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"steprequired--2",children:[(0,s.jsx)(n.code,{children:"step"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"step",id:"projen.github.GithubWorkflow.insertStepBefore.parameter.step"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step to insert."}),"\n",(0,s.jsxs)(n.p,{children:["Must have an ",(0,s.jsx)(n.code,{children:"id"})," set."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"on-",children:[(0,s.jsx)(n.code,{children:"on"})," ",(0,s.jsx)(n.a,{name:"on",id:"projen.github.GithubWorkflow.on"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public on(events: Triggers): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Add events to triggers the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"eventsrequired-",children:[(0,s.jsx)(n.code,{children:"events"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"events",id:"projen.github.GithubWorkflow.on.parameter.events"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Triggers",children:"Triggers"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The event(s) to trigger the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"patchstep-",children:[(0,s.jsx)(n.code,{children:"patchStep"})," ",(0,s.jsx)(n.a,{name:"patchStep",id:"projen.github.GithubWorkflow.patchStep"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public patchStep(jobId: string, stepId: string, patch: JobStep): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies a surgical modification to an existing step."}),"\n",(0,s.jsxs)(n.p,{children:["The provided patch is shallow-merged onto the existing step. Fields not\npresent in the patch are preserved unchanged. Use ",(0,s.jsx)(n.code,{children:"getStep"})," to read the\ncurrent step values before constructing the patch."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.em,{children:"Example"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:'// Add an env var without replacing existing ones:\nconst step = workflow.getStep("build", "install");\nworkflow.patchStep("build", "install", {\n  env: { ...step.env, NODE_AUTH_TOKEN: "${{ steps.jfrog.outputs.oidc-token }}" },\n});\n'})}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--4",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.GithubWorkflow.patchStep.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"stepidrequired--1",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.GithubWorkflow.patchStep.parameter.stepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the step to patch."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"patchrequired-",children:[(0,s.jsx)(n.code,{children:"patch"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"patch",id:"projen.github.GithubWorkflow.patchStep.parameter.patch"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A partial step object whose fields are shallow-merged onto the existing step."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"removejob-",children:[(0,s.jsx)(n.code,{children:"removeJob"})," ",(0,s.jsx)(n.a,{name:"removeJob",id:"projen.github.GithubWorkflow.removeJob"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public removeJob(id: string): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Removes a single job to the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"idrequired--2",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.GithubWorkflow.removeJob.parameter.id"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"removestep-",children:[(0,s.jsx)(n.code,{children:"removeStep"})," ",(0,s.jsx)(n.a,{name:"removeStep",id:"projen.github.GithubWorkflow.removeStep"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public removeStep(jobId: string, stepId: string): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Removes a step from a job by step ID."}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--5",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.GithubWorkflow.removeStep.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"stepidrequired--2",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.GithubWorkflow.removeStep.parameter.stepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the step to remove."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"replacestep-",children:[(0,s.jsx)(n.code,{children:"replaceStep"})," ",(0,s.jsx)(n.a,{name:"replaceStep",id:"projen.github.GithubWorkflow.replaceStep"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public replaceStep(jobId: string, stepId: string, replacementStep: JobStep): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Replaces an existing step in a job, preserving its position."}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--6",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.GithubWorkflow.replaceStep.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"stepidrequired--3",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.GithubWorkflow.replaceStep.parameter.stepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the step to replace."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"replacementsteprequired-",children:[(0,s.jsx)(n.code,{children:"replacementStep"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"replacementStep",id:"projen.github.GithubWorkflow.replaceStep.parameter.replacementStep"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The replacement step."}),"\n",(0,s.jsx)(

1n.p,{children:"Inherits the original step's ID."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"updatejob-",children:[(0,s.jsx)(n.code,{children:"updateJob"})," ",(0,s.jsx)(n.a,{name:"updateJob",id:"projen.github.GithubWorkflow.updateJob"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public updateJob(id: string, job: JobCallingReusableWorkflow | Job): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Updates a single job to the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"idrequired--3",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.GithubWorkflow.updateJob.parameter.id"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"jobrequired--1",children:[(0,s.jsx)(n.code,{children:"job"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"job",id:"projen.github.GithubWorkflow.updateJob.parameter.job"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"updatejobs-",children:[(0,s.jsx)(n.code,{children:"updateJobs"})," ",(0,s.jsx)(n.a,{name:"updateJobs",id:"projen.github.GithubWorkflow.updateJobs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public updateJobs(jobs: {[ key: string ]: JobCallingReusableWorkflow | Job}): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Updates jobs for this workflow Does a complete replace, it does not try to merge the jobs."}),"\n",(0,s.jsxs)(n.h6,{id:"jobsrequired--1",children:[(0,s.jsx)(n.code,{children:"jobs"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobs",id:"projen.github.GithubWorkflow.updateJobs.parameter.jobs"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"}),"}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Jobs to update."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--7",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--7",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.GithubWorkflow.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.GithubWorkflow.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--14",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.GithubWorkflow.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--6",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.GithubWorkflow.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.GithubWorkflow.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--15",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.GithubWorkflow.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--7",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.property.jobs",children:"jobs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["{[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"}),"}"]})}),(0,s.jsx)(n.td,{children:"All current jobs of the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.property.projenCredentials",children:"projenCredentials"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})})}),(0,s.jsx)(n.td,{children:"GitHub API authentication method used by projen workflows."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.property.concurrency",children:"concurrency"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ConcurrencyOptions",children:"ConcurrencyOptions"})})}),(0,s.jsx)(n.td,{children:"The concurrency configuration of the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.property.env",children:"env"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: string}"})}),(0,s.jsx)(n.td,{children:"Additional environment variables to set for the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.property.file",children:"file"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.YamlFile"})}),(0,s.jsx)(n.td,{children:"The workflow YAML file."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow.property.runName",children:"runName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name for workflow runs generated from the workflow."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--7",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.GithubWorkflow.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--8",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.GithubWorkflow.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"jobsrequired--2",children:[(0,s.jsx)(n.code,{children:"jobs"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobs",id:"projen.github.GithubWorkflow.property.jobs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly jobs: {[ key: string ]: JobCallingReusableWorkflow | Job};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"}),"}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"All current jobs of the workflow."}),"\n",(0,s.jsx)(n.p,{children:"This is a read-only copy, use the respective helper methods to add, update or remove jobs."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"namerequired--6",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.GithubWorkflow.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the workflow."}),"\n",(0,s.jsx)(n.p,{children:'GitHub displays the names of your workflows under your repository\'s\n"Actions" tab.'}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#name",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#name"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projencredentialsrequired--1",children:[(0,s.jsx)(n.code,{children:"projenCredentials"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"projenCredentials",id:"projen.github.GithubWorkflow.property.projenCredentials"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projenCredentials: GithubCredentials;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"GitHub API authentication method used by projen workflows."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"concurrencyoptional-",children:[(0,s.jsx)(n.code,{children:"concurrency"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"concurrency",id:"projen.github.GithubWorkflow.property.concurrency"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly concurrency: ConcurrencyOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.ConcurrencyOptions",children:"ConcurrencyOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The concurrency configuration of the workflow."}),"\n",(0,s.jsx)(n.p,{children:"undefined means no concurrency limitations."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"envoptional-",children:[(0,s.jsx)(n.code,{children:"env"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"env",id:"projen.github.GithubWorkflow.property.env"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly env: {[ key: string ]: string};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: string}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Additional environment variables to set for the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"fileoptional-",children:[(0,s.jsx)(n.code,{children:"file"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"file",id:"projen.github.GithubWorkflow.property.file"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly file: YamlFile;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.YamlFile"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The workflow YAML file."}),"\n",(0,s.jsxs)(n.p,{children:["May not exist if ",(0,s.jsx)(n.code,{children:"workflowsEnabled"})," is false on ",(0,s.jsx)(n.code,{children:"GitHub"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runnameoptional-",children:[(0,s.jsx)(n.code,{children:"runName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runName",id:"projen.github.GithubWorkflow.property.runName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{c

1hildren:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name for workflow runs generated from the workflow."}),"\n",(0,s.jsxs)(n.p,{children:['GitHub displays the\nworkflow run name in the list of workflow runs on your repository\'s\n"Actions" tab. If ',(0,s.jsx)(n.code,{children:"run-name"})," is omitted or is only whitespace, then the run\nname is set to event-specific information for the workflow run. For\nexample, for a workflow triggered by a ",(0,s.jsx)(n.code,{children:"push"})," or ",(0,s.jsx)(n.code,{children:"pull_request"})," event, it\nis set as the commit message."]}),"\n",(0,s.jsxs)(n.p,{children:["This value can include expressions and can reference ",(0,s.jsx)(n.code,{children:"github"})," and ",(0,s.jsx)(n.code,{children:"inputs"}),"\ncontexts."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"mergequeue-",children:["MergeQueue ",(0,s.jsx)(n.a,{name:"MergeQueue",id:"projen.github.MergeQueue"})]}),"\n",(0,s.jsx)(n.p,{children:"Merge pull requests using a merge queue."}),"\n",(0,s.jsxs)(n.h4,{id:"initializers--8",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.MergeQueue.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.MergeQueue(scope: IConstruct, options?: MergeQueueOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.Initializer.parameter.scope",children:"scope"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.IConstruct"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueueOptions",children:"MergeQueueOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"scoperequired--1",children:[(0,s.jsx)(n.code,{children:"scope"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"scope",id:"projen.github.MergeQueue.Initializer.parameter.scope"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.IConstruct"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--9",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.MergeQueue.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergeQueueOptions",children:"MergeQueueOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--8",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--8",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.MergeQueue.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--8",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.MergeQueue.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--8",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.MergeQueue.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--7",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.MergeQueue.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--14",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.MergeQueue.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--8",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.MergeQueue.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--8",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.MergeQueue.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--7",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.MergeQueue.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--15",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.MergeQueue.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--7",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.MergeQueue.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--8",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--8",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.MergeQueue.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.MergeQueue.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--16",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.MergeQueue.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--7",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.MergeQueue.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.MergeQueue.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--17",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.MergeQueue.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--8",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueue.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No descripti

1on."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--8",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.MergeQueue.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--9",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.MergeQueue.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"mergify-",children:["Mergify ",(0,s.jsx)(n.a,{name:"Mergify",id:"projen.github.Mergify"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializers--9",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.Mergify.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.Mergify(github: GitHub, options?: MergifyOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.Initializer.parameter.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyOptions",children:"MergifyOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githubrequired--5",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.Mergify.Initializer.parameter.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--10",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.Mergify.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyOptions",children:"MergifyOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--9",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.addQueue",children:"addQueue"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.addRule",children:"addRule"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--9",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.Mergify.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--9",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.Mergify.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--9",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.Mergify.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--8",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.Mergify.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--16",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.Mergify.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--9",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.Mergify.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--9",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.Mergify.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--8",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.Mergify.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--17",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.Mergify.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--8",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.Mergify.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h5,{id:"addqueue-",children:[(0,s.jsx)(n.code,{children:"addQueue"})," ",(0,s.jsx)(n.a,{name:"addQueue",id:"projen.github.Mergify.addQueue"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addQueue(queue: MergifyQueue): void\n"})}),"\n",(0,s.jsxs)(n.h6,{id:"queuerequired-",children:[(0,s.jsx)(n.code,{children:"queue"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"queue",id:"projen.github.Mergify.addQueue.parameter.queue"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyQueue",children:"MergifyQueue"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addrule-",children:[(0,s.jsx)(n.code,{children:"addRule"})," ",(0,s.jsx)(n.a,{name:"addRule",id:"projen.github.Mergify.addRule"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addRule(rule: MergifyRule): void\n"})}),"\n",(0,s.jsxs)(n.h6,{id:"rulerequired-",children:[(0,s.jsx)(n.code,{children:"rule"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"rule",id:"projen.github.Mergify.addRule.parameter.rule"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyRule",children:"MergifyRule"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--9",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--9",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.Mergify.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.Mergify.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--18",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.Mergi

1fy.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--8",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.Mergify.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.Mergify.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--19",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.Mergify.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--9",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Mergify.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--9",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.Mergify.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--10",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.Mergify.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"pullrequestbackport-",children:["PullRequestBackport ",(0,s.jsx)(n.a,{name:"PullRequestBackport",id:"projen.github.PullRequestBackport"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializers--10",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.PullRequestBackport.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.PullRequestBackport(scope: IConstruct, options?: PullRequestBackportOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.Initializer.parameter.scope",children:"scope"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.IConstruct"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions",children:"PullRequestBackportOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"scoperequired--2",children:[(0,s.jsx)(n.code,{children:"scope"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"scope",id:"projen.github.PullRequestBackport.Initializer.parameter.scope"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.IConstruct"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--11",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.PullRequestBackport.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions",children:"PullRequestBackportOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--10",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--10",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.PullRequestBackport.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--10",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.PullRequestBackport.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--10",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.PullRequestBackport.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--9",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.PullRequestBackport.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--18",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.PullRequestBackport.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--10",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.PullRequestBackport.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--10",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.PullRequestBackport.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--9",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.PullRequestBackport.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--19",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.PullRequestBackport.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--9",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.PullRequestBackport.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--10",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--10",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.PullRequestBackport.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.PullRequestBackport.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple c

1opies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--20",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.PullRequestBackport.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--9",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.PullRequestBackport.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.PullRequestBackport.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--21",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.PullRequestBackport.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--10",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.property.file",children:"file"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.JsonFile"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackport.property.workflow",children:"workflow"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow",children:"GithubWorkflow"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--10",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.PullRequestBackport.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--11",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.PullRequestBackport.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"filerequired-",children:[(0,s.jsx)(n.code,{children:"file"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"file",id:"projen.github.PullRequestBackport.property.file"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly file: JsonFile;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.JsonFile"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workflowrequired-",children:[(0,s.jsx)(n.code,{children:"workflow"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"workflow",id:"projen.github.PullRequestBackport.property.workflow"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workflow: GithubWorkflow;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflow",children:"GithubWorkflow"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"pullrequestlint-",children:["PullRequestLint ",(0,s.jsx)(n.a,{name:"PullRequestLint",id:"projen.github.PullRequestLint"})]}),"\n",(0,s.jsx)(n.p,{children:"Configure validations to run on GitHub pull requests."}),"\n",(0,s.jsx)(n.p,{children:"Only generates a file if at least one linter is configured."}

1),"\n",(0,s.jsxs)(n.h4,{id:"initializers--11",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.PullRequestLint.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.PullRequestLint(github: GitHub, options?: PullRequestLintOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.Initializer.parameter.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLintOptions",children:"PullRequestLintOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githubrequired--6",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.PullRequestLint.Initializer.parameter.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--12",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.PullRequestLint.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLintOptions",children:"PullRequestLintOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--11",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--11",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.PullRequestLint.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--11",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.PullRequestLint.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--11",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.PullRequestLint.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--10",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.PullRequestLint.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--20",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.PullRequestLint.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--11",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.PullRequestLint.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--11",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.PullRequestLint.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--10",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.PullRequestLint.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--21",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.PullRequestLint.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--10",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.PullRequestLint.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--11",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--11",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.PullRequestLint.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.PullRequestLint.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--22",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.PullRequestLint.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--10",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.PullRequestLint.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.PullRequestLint.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--23",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.PullRequestLint.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--11",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLint.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--11",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.PullRequestLint.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--12",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:

1"projen.github.PullRequestLint.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"pullrequesttemplate-",children:["PullRequestTemplate ",(0,s.jsx)(n.a,{name:"PullRequestTemplate",id:"projen.github.PullRequestTemplate"})]}),"\n",(0,s.jsx)(n.p,{children:"Template for GitHub pull requests."}),"\n",(0,s.jsxs)(n.h4,{id:"initializers--12",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.PullRequestTemplate.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.PullRequestTemplate(github: GitHub, options?: PullRequestTemplateOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.Initializer.parameter.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplateOptions",children:"PullRequestTemplateOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githubrequired--7",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.PullRequestTemplate.Initializer.parameter.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--13",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.PullRequestTemplate.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplateOptions",children:"PullRequestTemplateOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--12",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Writes the file to the project's output directory."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.diff",children:"diff"})})}),(0,s.jsx)(n.td,{children:"Returns a unified diff of the old and new file contents with context lines and hunk headers."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.addLine",children:"addLine"})})}),(0,s.jsx)(n.td,{children:"Adds a line to the text file."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--12",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.PullRequestTemplate.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--12",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.PullRequestTemplate.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--12",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.PullRequestTemplate.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--11",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.PullRequestTemplate.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--22",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.PullRequestTemplate.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--12",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.PullRequestTemplate.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--12",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.PullRequestTemplate.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--11",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.PullRequestTemplate.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--23",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.PullRequestTemplate.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--11",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.PullRequestTemplate.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Writes the file to the project's output directory."}),"\n",(0,s.jsxs)(n.h5,{id:"diff-",children:[(0,s.jsx)(n.code,{children:"diff"})," ",(0,s.jsx)(n.a,{name:"diff",id:"projen.github.PullRequestTemplate.diff"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public diff(colorize?: boolean, contextLines?: number): string[]\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a unified diff of the old and new file contents with context lines and hunk headers."}),"\n",(0,s.jsx)(n.p,{children:"Only available after synthesis."}),"\n",(0,s.jsx)(n.p,{children:"This is an expensive operation and should only be used on non time-critical\ncode paths, like debug output."}),"\n",(0,s.jsxs)(n.h6,{id:"colorizeoptional-",children:[(0,s.jsx)(n.code,{children:"colorize"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"colorize",id:"projen.github.PullRequestTemplate.diff.parameter.colorize"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to colorize the diff output."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"contextlinesoptional-",children:[(0,s.jsx)(n.code,{children:"contextLines"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"contextLines",id:"projen.github.PullRequestTemplate.diff.parameter.contextLines"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Number of context lines around changes."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addline-",children:[(0,s.jsx)(n.code,{children:"addLine"})," ",(0,s.jsx)(n.a,{name:"addLine",id:"projen.github.PullRequestTemplate.addLine"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addLine(line: string): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Adds a line to the text file."}),"\n",(0,s.jsxs)(n.h6,{id:"linerequired-",children:[(0,s.jsx)(n.code,{children:"line"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"line",id:"projen.github.PullRequestTemplate.addLine.parameter.line"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"the line to add (can use tokens)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--12",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.of",children:"of"})})}),(0,s.jsxs)(n.td,{children:["Returns the ",(0,s.jsx)(n.code,{children:"PullRequestTemplate"})," instance associated with a project or ",(0,s.jsx)(n.code,{children:"undefined"})," if there is no PullRequestTemplate."]})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--12",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.PullRequestTemplate.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.PullRequestTemplate.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Exp

1lanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--24",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.PullRequestTemplate.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--11",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.PullRequestTemplate.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.PullRequestTemplate.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--25",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.PullRequestTemplate.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"of--2",children:[(0,s.jsx)(n.code,{children:"of"})," ",(0,s.jsx)(n.a,{name:"of",id:"projen.github.PullRequestTemplate.of"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.PullRequestTemplate.of(project: Project)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns the ",(0,s.jsx)(n.code,{children:"PullRequestTemplate"})," instance associated with a project or ",(0,s.jsx)(n.code,{children:"undefined"})," if there is no PullRequestTemplate."]}),"\n",(0,s.jsxs)(n.h6,{id:"projectrequired--13",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.PullRequestTemplate.of.parameter.project"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--12",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.property.absolutePath",children:"absolutePath"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The absolute path of this file."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.property.committed",children:"committed"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Indicates if the file will be committed."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.property.path",children:"path"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The file path, relative to the project's outdir."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.property.changed",children:"changed"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Indicates if the file has been changed during synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.property.marker",children:"marker"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The projen marker, used to identify files as projen-generated."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.property.executable",children:"executable"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Indicates if the file should be marked as executable."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplate.property.readonly",children:"readonly"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Indicates if the file should be read-only or read-write."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--12",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.PullRequestTemplate.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--14",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.PullRequestTemplate.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"absolutepathrequired-",children:[(0,s.jsx)(n.code,{children:"absolutePath"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"absolutePath",id:"projen.github.PullRequestTemplate.property.absolutePath"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly absolutePath: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The absolute path of this file."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"committedrequired-",children:[(0,s.jsx)(n.code,{children:"committed"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"committed",id:"projen.github.PullRequestTemplate.property.committed"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly committed: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Indicates if the file will be committed."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pathrequired-",children:[(0,s.jsx)(n.code,{children:"path"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"path",id:"projen.github.PullRequestTemplate.property.path"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly path: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The file path, relative to the project's outdir."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"changedoptional-",children:[(0,s.jsx)(n.code,{children:"changed"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"changed",id:"projen.github.PullRequestTemplate.property.changed"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly changed: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Indicates if the file has been changed during synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["This property is\nonly available in ",(0,s.jsx)(n.code,{children:"postSynthesize()"})," hooks. If this is ",(0,s.jsx)(n.code,{children:"undefined"}),", the\nfile has not been synthesized yet."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"markeroptional-",children:[(0,s.jsx)(n.code,{children:"marker"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"marker",id:"projen.github.PullRequestTemplate.property.marker"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly marker: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The projen marker, used to identify files as projen-generated."}),"\n",(0,s.jsx)(n.p,{children:"Value is undefined if the project is being ejected."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"executablerequired-",children:[(0,s.jsx)(n.code,{children:"executable"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"executable",id:"projen.github.PullRequestTemplate.property.executable"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly executable: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Indicates if the file should be marked as executable."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"readonlyrequired-",children:[(0,s.jsx)(n.code,{children:"readonly"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"readonly",id:"projen.github.PullRequestTemplate.property.readonly"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly readonly: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Indicates if the file should be read-only or read-write."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"stale-",children:["Stale ",(0,s.jsx)(n.a,{name:"Stale",id:"projen.github.Stale"})]}),"\n",(0,s.jsx)(n.p,{children:"Warns and then closes issues and PRs that have had no activity for a specified amount of time."}),"\n",(0,s.jsx)(n.p,{children:"The default configuration will:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'Add a "Stale" label to pull requests after 14 days and closed after 2 days'}),"\n",(0,s.jsx)(n.li,{children:'Add a "Stale" label to issues after 60 days and closed after 7 days'}),"\n",(0,s.jsx)(n.li,{children:"If a comment is added, the label will be removed and timer is restarted."}),"\n"]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/actions/stale",children:"https://github.com/actions/stale"})}),"\n"]}

1),"\n",(0,s.jsxs)(n.h4,{id:"initializers--13",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.Stale.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.Stale(github: GitHub, options?: StaleOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.Initializer.parameter.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleOptions",children:"StaleOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githubrequired--8",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.Stale.Initializer.parameter.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsoptional--14",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.Stale.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.StaleOptions",children:"StaleOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--13",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--13",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.Stale.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--13",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.Stale.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--13",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.Stale.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--12",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.Stale.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--24",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.Stale.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--13",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.Stale.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--13",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.Stale.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--12",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.Stale.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--25",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.Stale.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--12",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.Stale.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--13",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--13",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.Stale.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.Stale.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--26",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.Stale.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--12",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.Stale.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.Stale.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--27",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.Stale.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--13",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.Stale.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--13",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.Stale.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--15",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.Stale.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"taskworkflow-",children:["TaskWorkfl

1ow ",(0,s.jsx)(n.a,{name:"TaskWorkflow",id:"projen.github.TaskWorkflow"})]}),"\n",(0,s.jsx)(n.p,{children:"A GitHub workflow for common build tasks within a project."}),"\n",(0,s.jsxs)(n.h4,{id:"initializers--14",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.TaskWorkflow.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.TaskWorkflow(github: GitHub, options: TaskWorkflowOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.Initializer.parameter.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions",children:"TaskWorkflowOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githubrequired--9",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.TaskWorkflow.Initializer.parameter.github"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHub",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsrequired--1",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.TaskWorkflow.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions",children:"TaskWorkflowOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--14",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.addJob",children:"addJob"})})}),(0,s.jsx)(n.td,{children:"Adds a single job to the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.addJobs",children:"addJobs"})})}),(0,s.jsx)(n.td,{children:"Add jobs to the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.appendStep",children:"appendStep"})})}),(0,s.jsx)(n.td,{children:"Appends a step to the end of a job's step list."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.getJob",children:"getJob"})})}),(0,s.jsx)(n.td,{children:"Get a single job from the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.getStep",children:"getStep"})})}),(0,s.jsx)(n.td,{children:"Gets a single step from a job by step ID."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.insertStepAfter",children:"insertStepAfter"})})}),(0,s.jsx)(n.td,{children:"Inserts a step after an existing step, identified by ID."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.insertStepBefore",children:"insertStepBefore"})})}),(0,s.jsx)(n.td,{children:"Inserts a step before an existing step, identified by ID."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.on",children:"on"})})}),(0,s.jsx)(n.td,{children:"Add events to triggers the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.patchStep",children:"patchStep"})})}),(0,s.jsx)(n.td,{children:"Applies a surgical modification to an existing step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.removeJob",children:"removeJob"})})}),(0,s.jsx)(n.td,{children:"Removes a single job to the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.removeStep",children:"removeStep"})})}),(0,s.jsx)(n.td,{children:"Removes a step from a job by step ID."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.replaceStep",children:"replaceStep"})})}),(0,s.jsx)(n.td,{children:"Replaces an existing step in a job, preserving its position."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.updateJob",children:"updateJob"})})}),(0,s.jsx)(n.td,{children:"Updates a single job to the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.updateJobs",children:"updateJobs"})})}),(0,s.jsx)(n.td,{children:"Updates jobs for this workflow Does a complete replace, it does not try to merge the jobs."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--14",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.TaskWorkflow.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}),"\n",(0,s.jsxs)(n.h5,{id:"with--14",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.TaskWorkflow.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--14",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.TaskWorkflow.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--13",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.TaskWorkflow.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--26",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.TaskWorkflow.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--14",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.TaskWorkflow.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--14",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.TaskWorkflow.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--13",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.TaskWorkflow.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--27",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.TaskWorkflow.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--13",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.TaskWorkflow.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h5,{id:"addjob--1",children:[(0,s.jsx)(n.code,{children:"addJob"})," ",(0,s.jsx)(n.a,{name:"addJob",id:"projen.github.TaskWorkflow.addJob"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addJob(id: string, job: JobCallingReusableWorkflow | Job): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Adds a single job to the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"idrequired--4",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.TaskWorkflow.addJob.parameter.id"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"jobrequired--2",children:[(0,s.jsx)(n.code,{children:"job"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"job",id:"projen.github.TaskWorkflow.addJob.parameter.job"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job specification."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addjobs--1",children:[(0,s.jsx)(n.code,{children:"addJobs"})," ",(0,s.jsx)(n.a,{name:"addJobs",id:"projen.github.TaskWorkflow.addJobs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public addJobs(jobs: {[ key: string ]: JobCallingReusableWorkflow | Job}): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Add jobs to the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"jobsrequired--3",children:[(0,s.jsx)(n.code,{children:"jobs"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobs",id:"projen.github.TaskWorkflow.addJobs.parameter.jobs"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.

1li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"}),"}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Jobs to add."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"appendstep--1",children:[(0,s.jsx)(n.code,{children:"appendStep"})," ",(0,s.jsx)(n.a,{name:"appendStep",id:"projen.github.TaskWorkflow.appendStep"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public appendStep(jobId: string, step: JobStep): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Appends a step to the end of a job's step list."}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--7",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.TaskWorkflow.appendStep.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"steprequired--3",children:[(0,s.jsx)(n.code,{children:"step"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"step",id:"projen.github.TaskWorkflow.appendStep.parameter.step"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step to add."}),"\n",(0,s.jsxs)(n.p,{children:["Must have an ",(0,s.jsx)(n.code,{children:"id"})," set."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"getjob--1",children:[(0,s.jsx)(n.code,{children:"getJob"})," ",(0,s.jsx)(n.a,{name:"getJob",id:"projen.github.TaskWorkflow.getJob"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public getJob(id: string): JobCallingReusableWorkflow | Job\n"})}),"\n",(0,s.jsx)(n.p,{children:"Get a single job from the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"idrequired--5",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.TaskWorkflow.getJob.parameter.id"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"getstep--1",children:[(0,s.jsx)(n.code,{children:"getStep"})," ",(0,s.jsx)(n.a,{name:"getStep",id:"projen.github.TaskWorkflow.getStep"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public getStep(jobId: string, stepId: string): JobStep\n"})}),"\n",(0,s.jsx)(n.p,{children:"Gets a single step from a job by step ID."}),"\n",(0,s.jsxs)(n.p,{children:["The returned object is frozen and read-only. Use ",(0,s.jsx)(n.code,{children:"replaceStep"})," or\n",(0,s.jsx)(n.code,{children:"patchStep"})," to modify a step."]}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--8",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.TaskWorkflow.getStep.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"stepidrequired--4",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.TaskWorkflow.getStep.parameter.stepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step ID to look up."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"insertstepafter--1",children:[(0,s.jsx)(n.code,{children:"insertStepAfter"})," ",(0,s.jsx)(n.a,{name:"insertStepAfter",id:"projen.github.TaskWorkflow.insertStepAfter"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public insertStepAfter(jobId: string, referenceStepId: string, step: JobStep): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Inserts a step after an existing step, identified by ID."}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--9",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.TaskWorkflow.insertStepAfter.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"referencestepidrequired--2",children:[(0,s.jsx)(n.code,{children:"referenceStepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"referenceStepId",id:"projen.github.TaskWorkflow.insertStepAfter.parameter.referenceStepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the step to insert after."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"steprequired--4",children:[(0,s.jsx)(n.code,{children:"step"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"step",id:"projen.github.TaskWorkflow.insertStepAfter.parameter.step"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step to insert."}),"\n",(0,s.jsxs)(n.p,{children:["Must have an ",(0,s.jsx)(n.code,{children:"id"})," set."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"insertstepbefore--1",children:[(0,s.jsx)(n.code,{children:"insertStepBefore"})," ",(0,s.jsx)(n.a,{name:"insertStepBefore",id:"projen.github.TaskWorkflow.insertStepBefore"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public insertStepBefore(jobId: string, referenceStepId: string, step: JobStep): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Inserts a step before an existing step, identified by ID."}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--10",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.TaskWorkflow.insertStepBefore.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"referencestepidrequired--3",children:[(0,s.jsx)(n.code,{children:"referenceStepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"referenceStepId",id:"projen.github.TaskWorkflow.insertStepBefore.parameter.referenceStepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the step to insert before."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"steprequired--5",children:[(0,s.jsx)(n.code,{children:"step"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"step",id:"projen.github.TaskWorkflow.insertStepBefore.parameter.step"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step to insert."}),"\n",(0,s.jsxs)(n.p,{children:["Must have an ",(0,s.jsx)(n.code,{children:"id"})," set."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"on--1",children:[(0,s.jsx)(n.code,{children:"on"})," ",(0,s.jsx)(n.a,{name:"on",id:"projen.github.TaskWorkflow.on"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public on(events: Triggers): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Add events to triggers the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"eventsrequired--1",children:[(0,s.jsx)(n.code,{children:"events"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"events",id:"projen.github.TaskWorkflow.on.parameter.events"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Triggers",children:"Triggers"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The event(s) to trigger the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"patchstep--1",children:[(0,s.jsx)(n.code,{children:"patchStep"})," ",(0,s.jsx)(n.a,{name:"patchStep",id:"projen.github.TaskWorkflow.patchStep"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public patchStep(jobId: string, stepId: string, patch: JobStep): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies a surgical modification to an existing step."}),"\n",(0,s.jsxs)(n.p,{children:["The provided patch is shallow-merged onto the existing step. Fields not\npresent in the patch are preserved unchanged. Use ",(0,s.jsx)(n.code,{children:"getStep"})," to read the\ncurrent step values before constructing the patch."]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.em,{children:"Example"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:'// Add an env var without replacing existing ones:\nconst step = workflow.getStep("build", "install");\nworkflow.patchStep("build", "install", {\n  env: { ...step.env, NODE_AUTH_TOKEN: "${{ steps.jfrog.outputs.oidc-token }}" },\n});\n'})}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--11",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.TaskWorkflow.patchStep.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"stepidrequired--5",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.TaskWorkflow.patchStep.parameter.stepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the step to patch."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"patchrequired--1",children:[(0,s.jsx)(n.code,{children:"patch"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"patch",id:"projen.github.TaskWorkflow.patchStep.parameter.patch"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A partial step object whose fields are shallow-merged onto the existing step."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"removejob--1",children:[(0,s.jsx)(n.code,{children:"removeJob"})," ",(0,s.jsx)(n.a,{name:"removeJob",id:"projen.github.TaskWorkflow.removeJob"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public removeJob(id: string): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Removes a single job to the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"idrequired--6",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.TaskWorkflow.removeJob.parameter.id"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"removestep--1",children:[(0,s.jsx)(n.code,{children:"removeStep"})," ",(0,s.jsx)(n.a,{name:"removeStep",id:"projen.github.TaskWorkflow.removeStep"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public removeStep(jobId: string, stepId: string): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Removes a step from a job by step ID."}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--12",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.TaskWorkflow.removeStep.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"stepidrequired--6",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.TaskWorkflow.removeStep.parameter.stepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the step to remove."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"replacestep--1",children:[(0,s.jsx)(n.code,{children:"replaceStep"})," ",(0,s.jsx)(n.a,{name:"replaceStep",id:"projen.github.TaskWorkflow.replaceStep"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public replaceStep(jobId: string, stepId: string, replacementStep: JobStep): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Replaces an existing step in a job, preserving its position."}),"\n",(0,s.jsxs)(n.h6,{id:"jobidrequired--13",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.TaskWorkflow.replaceStep.parameter.jobId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"stepidrequired--7",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.TaskWorkflow.replaceStep.parameter.stepId"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The ID of the step to replace."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"replacementsteprequired--1",children:[(0,s.jsx)(n.code,{children:"replacementStep"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"replacementStep",id:"projen.github.TaskWorkflow.replaceStep.parameter.replacementStep"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The replacement step."}),"\n",(0,s.jsx)(n.p,{children:"Inherits the original step's ID."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"updatejob--1",children:[(0,s.jsx)(n.code,{children:"updateJob"})," ",(0,s.jsx)(n.a,{name:"updateJob",id:"projen.github.TaskWorkflow.updateJob"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public updateJob(id: string, job: JobCallingReusableWorkflow | Job): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Updates a single job to the workflow."}),"\n",(0,s.jsxs)(n.h6,{id:"idrequired--7",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.TaskWorkflow.updateJob.parameter.id"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job name (unique within the workflow)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"jobrequired--3",children:[(0,s

1.jsx)(n.code,{children:"job"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"job",id:"projen.github.TaskWorkflow.updateJob.parameter.job"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"updatejobs--1",children:[(0,s.jsx)(n.code,{children:"updateJobs"})," ",(0,s.jsx)(n.a,{name:"updateJobs",id:"projen.github.TaskWorkflow.updateJobs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public updateJobs(jobs: {[ key: string ]: JobCallingReusableWorkflow | Job}): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Updates jobs for this workflow Does a complete replace, it does not try to merge the jobs."}),"\n",(0,s.jsxs)(n.h6,{id:"jobsrequired--4",children:[(0,s.jsx)(n.code,{children:"jobs"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobs",id:"projen.github.TaskWorkflow.updateJobs.parameter.jobs"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"}),"}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Jobs to update."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--14",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--14",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.TaskWorkflow.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.TaskWorkflow.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--28",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.TaskWorkflow.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--13",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.TaskWorkflow.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.TaskWorkflow.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--29",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.TaskWorkflow.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--14",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.jobs",children:"jobs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["{[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"}),"}"]})}),(0,s.jsx)(n.td,{children:"All current jobs of the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.projenCredentials",children:"projenCredentials"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})})}),(0,s.jsx)(n.td,{children:"GitHub API authentication method used by projen workflows."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.concurrency",children:"concurrency"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ConcurrencyOptions",children:"ConcurrencyOptions"})})}),(0,s.jsx)(n.td,{children:"The concurrency configuration of the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.env",children:"env"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: string}"})}),(0,s.jsx)(n.td,{children:"Additional environment variables to set for the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.file",children:"file"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.YamlFile"})}),(0,s.jsx)(n.td,{children:"The workflow YAML file."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.runName",children:"runName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name for workflow runs generated from the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.jobId",children:"jobId"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflow.property.artifactsDirectory",children:"artifactsDirectory"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--14",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.TaskWorkflow.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--16",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.TaskWorkflow.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"jobsrequired--5",children:[(0,s.jsx)(n.code,{children:"jobs"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobs",id:"projen.github.TaskWorkflow.property.jobs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly jobs: {[ key: string ]: JobCallingReusableWorkflow | Job};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobCallingReusableWorkflow",children:"JobCallingReusableWorkflow"})," | ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Job",children:"Job"}),"}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"All current jobs of the workflow."}),"\n",(0,s.jsx)(n.p,{children:"This is a read-only copy, use the respective helper methods to add, update or remove jobs."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"namerequired--7",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.TaskWorkflow.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the workflow."}),"\n",(0,s.jsx)(n.p,{children:'GitHub displays the names of your workflows under your repository\'s\n"Actions" tab.'}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#name",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#name"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projencredentialsrequired--2",children:[(0,s.jsx)(n.code,{children:"projenCredentials"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"projenCredentials",id:"projen.github.TaskWorkflow.property.projenCredentials"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projenCredentials: GithubCredentials;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"GitHub API authentication method used by projen workflows."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"concurrencyoptional--1",children:[(0,s.jsx)(n.code,{children:"concurrency"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"concurrency",id:"projen.github.TaskWorkflow.property.concurrency"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly concurrency: ConcurrencyOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.ConcurrencyOptions",children:"ConcurrencyOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The concurrency configuration of the workflow."}),"\n",(0,s.jsx)(n.p,{children:"undefined means no concurrency limitations."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"envoptional--1",children:[(0,s.jsx)(n.code,{children:"env"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"env",id:"projen.github.TaskWorkflow.property.env"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly env: {[ key: string ]: string};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: string}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Additional environment variables to set for the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"fileoptional--1",children:[(0,s.jsx)(n.code,{children:"file"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"file",id:"projen.github.TaskWorkflow.property.file"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly file: YamlFile;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.YamlFile"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The workflow YAML file."}),"\n",(0,s.jsxs)(n.p,{children:["May not exist if ",(0,s.jsx)(n.code,{children:"workflowsEnabled"})," is false on ",(0,s.jsx)(n.code,{children:"GitHub"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runnameoptional--1",children:[(0,s.jsx)(n.code,{children:"runName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runName",id:"projen.github.TaskWorkflow.property.runName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name for workflow runs generated from the workflow."}),"\n",(0,s.jsxs)(n.p,{children:['GitHub displays the\nworkflow run name in the list of workflow runs on your repository\'s\n"Actions" tab. If ',(0,s.jsx)(n.code,{children:"run-name"})," is omitted or is only whit

1espace, then the run\nname is set to event-specific information for the workflow run. For\nexample, for a workflow triggered by a ",(0,s.jsx)(n.code,{children:"push"})," or ",(0,s.jsx)(n.code,{children:"pull_request"})," event, it\nis set as the commit message."]}),"\n",(0,s.jsxs)(n.p,{children:["This value can include expressions and can reference ",(0,s.jsx)(n.code,{children:"github"})," and ",(0,s.jsx)(n.code,{children:"inputs"}),"\ncontexts."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"jobidrequired--14",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.TaskWorkflow.property.jobId"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly jobId: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"artifactsdirectoryoptional-",children:[(0,s.jsx)(n.code,{children:"artifactsDirectory"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"artifactsDirectory",id:"projen.github.TaskWorkflow.property.artifactsDirectory"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly artifactsDirectory: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"taskworkflowjob-",children:["TaskWorkflowJob ",(0,s.jsx)(n.a,{name:"TaskWorkflowJob",id:"projen.github.TaskWorkflowJob"})]}),"\n",(0,s.jsx)(n.p,{children:"The primary or initial job of a TaskWorkflow."}),"\n",(0,s.jsxs)(n.h4,{id:"initializers--15",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.TaskWorkflowJob.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.TaskWorkflowJob(scope: IConstruct, task: Task, options: TaskWorkflowJobOptions)\n"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.Initializer.parameter.scope",children:"scope"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.IConstruct"})}),(0,s.jsx)(n.td,{children:"should be part of the project the Task belongs to."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.Initializer.parameter.task",children:"task"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Task"})}),(0,s.jsx)(n.td,{children:"the main task that is run as part of this job."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.Initializer.parameter.options",children:"options"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions",children:"TaskWorkflowJobOptions"})})}),(0,s.jsx)(n.td,{children:"options to configure the TaskWorkflowJob."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"scoperequired--3",children:[(0,s.jsx)(n.code,{children:"scope"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"scope",id:"projen.github.TaskWorkflowJob.Initializer.parameter.scope"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.IConstruct"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"should be part of the project the Task belongs to."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"taskrequired--1",children:[(0,s.jsx)(n.code,{children:"task"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"task",id:"projen.github.TaskWorkflowJob.Initializer.parameter.task"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Task"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"the main task that is run as part of this job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"optionsrequired--2",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.TaskWorkflowJob.Initializer.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions",children:"TaskWorkflowJobOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"options to configure the TaskWorkflowJob."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--15",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.toString",children:"toString"})})}),(0,s.jsx)(n.td,{children:"Returns a string representation of this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.with",children:"with"})})}),(0,s.jsx)(n.td,{children:"Applies one or more mixins to this construct."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.postProjectCreation",children:"postProjectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.postSynthesize",children:"postSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called after synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.preSynthesize",children:"preSynthesize"})})}),(0,s.jsx)(n.td,{children:"Called before synthesis."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.projectCreation",children:"projectCreation"})})}),(0,s.jsxs)(n.td,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.synthesize",children:"synthesize"})})}),(0,s.jsx)(n.td,{children:"Synthesizes files to the project output directory."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tostring--15",children:[(0,s.jsx)(n.code,{children:"toString"})," ",(0,s.jsx)(n.a,{name:"toString",id:"projen.github.TaskWorkflowJob.toString"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public toString(): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns a string representation of this construct."}

1),"\n",(0,s.jsxs)(n.h5,{id:"with--15",children:[(0,s.jsx)(n.code,{children:"with"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.TaskWorkflowJob.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public with(mixins: ...IMixin[]): IConstruct\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies one or more mixins to this construct."}),"\n",(0,s.jsxs)(n.p,{children:["Mixins are applied in order. The list of constructs is captured at the\nstart of the call, so constructs added by a mixin will not be visited.\nUse multiple ",(0,s.jsx)(n.code,{children:"with()"})," calls if subsequent mixins should apply to added\nconstructs."]}),"\n",(0,s.jsxs)(n.h6,{id:"mixinsrequired--15",children:[(0,s.jsx)(n.code,{children:"mixins"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"mixins",id:"projen.github.TaskWorkflowJob.with.parameter.mixins"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ...constructs.IMixin[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The mixins to apply."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postprojectcreation--14",children:[(0,s.jsx)(n.code,{children:"postProjectCreation"})," ",(0,s.jsx)(n.a,{name:"postProjectCreation",id:"projen.github.TaskWorkflowJob.postProjectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postProjectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"postSynthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nIt is also skipped when post-synthesis steps are disabled, e.g. ",(0,s.jsx)(n.code,{children:"--no-post"})," or ",(0,s.jsx)(n.code,{children:"PROJEN_DISABLE_POST"}),".\nUse it for one-off setup that can be turned off by the user, like running a task to give the user immediate\nfeedback on their new project. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--28",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.TaskWorkflowJob.postProjectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postsynthesize--15",children:[(0,s.jsx)(n.code,{children:"postSynthesize"})," ",(0,s.jsx)(n.a,{name:"postSynthesize",id:"projen.github.TaskWorkflowJob.postSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public postSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called after synthesis."}),"\n",(0,s.jsxs)(n.p,{children:["Order is ",(0,s.jsx)(n.em,{children:"not"})," guaranteed."]}),"\n",(0,s.jsxs)(n.h5,{id:"presynthesize--15",children:[(0,s.jsx)(n.code,{children:"preSynthesize"})," ",(0,s.jsx)(n.a,{name:"preSynthesize",id:"projen.github.TaskWorkflowJob.preSynthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public preSynthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Called before synthesis."}),"\n",(0,s.jsxs)(n.h5,{id:"projectcreation--14",children:[(0,s.jsx)(n.code,{children:"projectCreation"})," ",(0,s.jsx)(n.a,{name:"projectCreation",id:"projen.github.TaskWorkflowJob.projectCreation"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public projectCreation(initProject: InitProject): void\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Called once, right after ",(0,s.jsx)(n.code,{children:"synthesize()"}),", only when the project is created for the first time."]}),"\n",(0,s.jsxs)(n.p,{children:["It does not run on later ",(0,s.jsx)(n.code,{children:"projen"})," invocations. It only fires for ",(0,s.jsx)(n.code,{children:"projen new"})," (or ",(0,s.jsx)(n.code,{children:"Projects.createProject"}),").\nUse it for deterministic, one-off file generation. Order across components is not guaranteed."]}),"\n",(0,s.jsxs)(n.h6,{id:"initprojectrequired--29",children:[(0,s.jsx)(n.code,{children:"initProject"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"initProject",id:"projen.github.TaskWorkflowJob.projectCreation.parameter.initProject"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.InitProject"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Details about how the project was created, e.g. its type and the original CLI args."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"synthesize--14",children:[(0,s.jsx)(n.code,{children:"synthesize"})," ",(0,s.jsx)(n.a,{name:"synthesize",id:"projen.github.TaskWorkflowJob.synthesize"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public synthesize(): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Synthesizes files to the project output directory."}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--15",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.isConstruct",children:"isConstruct"})})}),(0,s.jsxs)(n.td,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.isComponent",children:"isComponent"})})}),(0,s.jsx)(n.td,{children:"Test whether the given construct is a component."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"isconstruct--15",children:[(0,s.jsx)(n.code,{children:"isConstruct"})," ",(0,s.jsx)(n.a,{name:"isConstruct",id:"projen.github.TaskWorkflowJob.isConstruct"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.TaskWorkflowJob.isConstruct(x: any)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if ",(0,s.jsx)(n.code,{children:"x"})," is a construct."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this method instead of ",(0,s.jsx)(n.code,{children:"instanceof"})," to properly detect ",(0,s.jsx)(n.code,{children:"Construct"}),"\ninstances, even when the construct library is symlinked."]}),"\n",(0,s.jsxs)(n.p,{children:["Explanation: in JavaScript, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"})," library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class ",(0,s.jsx)(n.code,{children:"Construct"})," in each copy of the ",(0,s.jsx)(n.code,{children:"constructs"})," library\nis seen as a different class, and an instance of one class will not test as\n",(0,s.jsx)(n.code,{children:"instanceof"})," the other class. ",(0,s.jsx)(n.code,{children:"npm install"})," will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the ",(0,s.jsx)(n.code,{children:"constructs"}),"\nlibrary can be accidentally installed, and ",(0,s.jsx)(n.code,{children:"instanceof"})," will behave\nunpredictably. It is safest to avoid using ",(0,s.jsx)(n.code,{children:"instanceof"}),", and using\nthis type-testing method instead."]}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--30",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.TaskWorkflowJob.isConstruct.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Any object."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"iscomponent--14",children:[(0,s.jsx)(n.code,{children:"isComponent"})," ",(0,s.jsx)(n.a,{name:"isComponent",id:"projen.github.TaskWorkflowJob.isComponent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.TaskWorkflowJob.isComponent(x: any)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Test whether the given construct is a component."}),"\n",(0,s.jsxs)(n.h6,{id:"xrequired--31",children:[(0,s.jsx)(n.code,{children:"x"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"x",id:"projen.github.TaskWorkflowJob.isComponent.parameter.x"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--15",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.node",children:"node"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"constructs.Node"})}),(0,s.jsx)(n.td,{children:"The tree node."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.project",children:"project"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.permissions",children:"permissions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobPermissions",children:"JobPermissions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.steps",children:"steps"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.concurrency",children:"concurrency"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"any"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.container",children:"container"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.ContainerOptions",children:"ContainerOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.continueOnError",children:"continueOnError"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.defaults",children:"defaults"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobDefaults",children:"JobDefaults"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.env",children:"env"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: string}"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.environment",children:"environment"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.if",children:"if"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.needs",children:"needs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.outputs",children:"outputs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["{[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStepOutput",children:"JobStepOutput"}),"}"]})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.runsOn",children:"runsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.runsOnGroup",children:"runsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.services",children:"services"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["{[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.ContainerOptions",children:"ContainerOptions"}),"}"]})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.strategy",children:"strategy"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStrategy",children:"JobStrategy"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{h

1ref:"#projen.github.TaskWorkflowJob.property.timeoutMinutes",children:"timeoutMinutes"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJob.property.tools",children:"tools"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.Tools",children:"Tools"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"noderequired--15",children:[(0,s.jsx)(n.code,{children:"node"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"node",id:"projen.github.TaskWorkflowJob.property.node"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly node: Node;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," constructs.Node"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tree node."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projectrequired--17",children:[(0,s.jsx)(n.code,{children:"project"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"project",id:"projen.github.TaskWorkflowJob.property.project"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly project: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"permissionsrequired-",children:[(0,s.jsx)(n.code,{children:"permissions"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"permissions",id:"projen.github.TaskWorkflowJob.property.permissions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly permissions: JobPermissions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobPermissions",children:"JobPermissions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"stepsrequired-",children:[(0,s.jsx)(n.code,{children:"steps"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"steps",id:"projen.github.TaskWorkflowJob.property.steps"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly steps: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"concurrencyoptional--2",children:[(0,s.jsx)(n.code,{children:"concurrency"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"concurrency",id:"projen.github.TaskWorkflowJob.property.concurrency"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly concurrency: any;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," any"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"containeroptional-",children:[(0,s.jsx)(n.code,{children:"container"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"container",id:"projen.github.TaskWorkflowJob.property.container"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly container: ContainerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.ContainerOptions",children:"ContainerOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"continueonerroroptional-",children:[(0,s.jsx)(n.code,{children:"continueOnError"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"continueOnError",id:"projen.github.TaskWorkflowJob.property.continueOnError"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly continueOnError: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"defaultsoptional-",children:[(0,s.jsx)(n.code,{children:"defaults"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"defaults",id:"projen.github.TaskWorkflowJob.property.defaults"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly defaults: JobDefaults;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobDefaults",children:"JobDefaults"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"envoptional--2",children:[(0,s.jsx)(n.code,{children:"env"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"env",id:"projen.github.TaskWorkflowJob.property.env"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly env: {[ key: string ]: string};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: string}"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"environmentoptional-",children:[(0,s.jsx)(n.code,{children:"environment"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"environment",id:"projen.github.TaskWorkflowJob.property.environment"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly environment: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"ifoptional-",children:[(0,s.jsx)(n.code,{children:"if"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"if",id:"projen.github.TaskWorkflowJob.property.if"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly if: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"nameoptional-",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.TaskWorkflowJob.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"needsoptional-",children:[(0,s.jsx)(n.code,{children:"needs"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"needs",id:"projen.github.TaskWorkflowJob.property.needs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly needs: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"outputsoptional-",children:[(0,s.jsx)(n.code,{children:"outputs"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"outputs",id:"projen.github.TaskWorkflowJob.property.outputs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly outputs: {[ key: string ]: JobStepOutput};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStepOutput",children:"JobStepOutput"}),"}"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonoptional-",children:[(0,s.jsx)(n.code,{children:"runsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOn",id:"projen.github.TaskWorkflowJob.property.runsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsongroupoptional-",children:[(0,s.jsx)(n.code,{children:"runsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOnGroup",id:"projen.github.TaskWorkflowJob.property.runsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"servicesoptional-",children:[(0,s.jsx)(n.code,{children:"services"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"services",id:"projen.github.TaskWorkflowJob.property.services"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly services: {[ key: string ]: ContainerOptions};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.ContainerOptions",children:"ContainerOptions"}),"}"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"strategyoptional-",children:[(0,s.jsx)(n.code,{children:"strategy"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"strategy",id:"projen.github.TaskWorkflowJob.property.strategy"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly strategy: JobStrategy;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStrategy",children:"JobStrategy"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"timeoutminutesoptional-",children:[(0,s.jsx)(n.code,{children:"timeoutMinutes"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"timeoutMinutes",id:"projen.github.TaskWorkflowJob.property.timeoutMinutes"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly timeoutMinutes: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"toolsoptional-",children:[(0,s.jsx)(n.code,{children:"tools"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"tools",id:"projen.github.TaskWorkflowJob.property.tools"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly tools: Tools;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Tools",children:"Tools"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h2,{id:"structs-",children:["Structs ",(0,s.jsx)(n.a,{name:"Structs",id:"Structs"})]}),"\n",(0,s.jsxs)(n.h3,{id:"autoapproveoptions-",children:["AutoApproveOptions ",(0,s.jsx)(n.a,{name:"AutoApproveOptions",id:"projen.github.AutoApproveOptions"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for 'AutoApprove'."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer-",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.AutoApproveOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst autoApproveOptions: github.AutoApproveOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--16",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApproveOptions.property.runsOn",children:"runsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Github Runner selection labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApproveOptions.property.runsOnGroup",children:"runsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:"Github Runner Group selection options."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApproveOptions.property.allowedUsernames",children:"allowedUsernames"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Only pull requests authored by these Github usernames will be auto-approved."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApproveOptions.property.label",children:"label"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Only pull requests with this label will be auto-approved."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApproveOptions.property.secret",children:"secret"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["A GitHub secret name which contains a GitHub Access Token with write permissions for the ",(0,s.jsx)(n.code,{children:"pull_request"})," scope."]})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonoptional--1",children:[(0,s.jsx)(n.code,{children:"runsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOn",id:"projen.github.AutoApproveOptions.property.runsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["ubuntu-latest"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner selection labels."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsongroupoptional--1",children:[(0,s.jsx)(n.code,{children:"runsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOnGroup",id:"projen.github.AutoApproveOptions.property.runsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner Group selection options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"allowedusernamesoptional-",children:[(0,s.jsx)(n.code,{children:"allowedUsernames"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"allowedUsernames",id:"projen.github.AutoApproveOptions.property.allowedUsernames"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly allowedUsernames: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.

1jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," ['github-bot']"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Only pull requests authored by these Github usernames will be auto-approved."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"labeloptional-",children:[(0,s.jsx)(n.code,{children:"label"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"label",id:"projen.github.AutoApproveOptions.property.label"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly label: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," 'auto-approve'"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Only pull requests with this label will be auto-approved."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"secretoptional-",children:[(0,s.jsx)(n.code,{children:"secret"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"secret",id:"projen.github.AutoApproveOptions.property.secret"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly secret: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "GITHUB_TOKEN"']}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A GitHub secret name which contains a GitHub Access Token with write permissions for the ",(0,s.jsx)(n.code,{children:"pull_request"})," scope."]}),"\n",(0,s.jsx)(n.p,{children:"This token is used to approve pull requests."}),"\n",(0,s.jsxs)(n.p,{children:["Github forbids an identity to approve its own pull request.\nIf your project produces automated pull requests using the Github default token -\n{@link ",(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/reference/authentication-in-a-workflow",children:"https://docs.github.com/en/actions/reference/authentication-in-a-workflow"})," ",(0,s.jsx)(n.code,{children:"GITHUB_TOKEN"})," }"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["that you would like auto approved, such as when using the ",(0,s.jsx)(n.code,{children:"depsUpgrade"})," property in\n",(0,s.jsx)(n.code,{children:"NodeProjectOptions"}),", then you must use a different token here."]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"automergeoptions-",children:["AutoMergeOptions ",(0,s.jsx)(n.a,{name:"AutoMergeOptions",id:"projen.github.AutoMergeOptions"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--1",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.AutoMergeOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst autoMergeOptions: github.AutoMergeOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--17",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMergeOptions.property.approvedReviews",children:"approvedReviews"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Number of approved code reviews."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMergeOptions.property.blockingLabels",children:"blockingLabels"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"List of labels that will prevent auto-merging."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMergeOptions.property.queueName",children:"queueName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Name of the mergify queue."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMergeOptions.property.ruleName",children:"ruleName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Name of the mergify rule."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"approvedreviewsoptional-",children:[(0,s.jsx)(n.code,{children:"approvedReviews"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"approvedReviews",id:"projen.github.AutoMergeOptions.property.approvedReviews"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly approvedReviews: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," 1"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Number of approved code reviews."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"blockinglabelsoptional-",children:[(0,s.jsx)(n.code,{children:"blockingLabels"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"blockingLabels",id:"projen.github.AutoMergeOptions.property.blockingLabels"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly blockingLabels: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," ['do-not-merge']"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"List of labels that will prevent auto-merging."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"queuenameoptional-",children:[(0,s.jsx)(n.code,{children:"queueName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"queueName",id:"projen.github.AutoMergeOptions.property.queueName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly queueName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," 'default'"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Name of the mergify queue."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"rulenameoptional-",children:[(0,s.jsx)(n.code,{children:"ruleName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"ruleName",id:"projen.github.AutoMergeOptions.property.ruleName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ruleName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," 'Automatic merge on approval and successful build'"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Name of the mergify rule."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"autoqueueoptions-",children:["AutoQueueOptions ",(0,s.jsx)(n.a,{name:"AutoQueueOptions",id:"projen.github.AutoQueueOptions"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for 'AutoQueue'."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--2",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.AutoQueueOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst autoQueueOptions: github.AutoQueueOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--18",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions.property.runsOn",children:"runsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Github Runner selection labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions.property.runsOnGroup",children:"runsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:"Github Runner Group selection options."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions.property.allowedUsernames",children:"allowedUsernames"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Only pull requests authored by these Github usernames will have auto-queue enabled."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions.property.labels",children:"labels"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Only pull requests with one of this labels will have auto-queue enabled."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions.property.mergeMethod",children:"mergeMethod"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeMethod",children:"MergeMethod"})})}),(0,s.jsx)(n.td,{children:"The method used to add the PR to the merge queue Any branch protection rules must allow this merge method."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions.property.projenCredentials",children:"projenCredentials"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})})}),(0,s.jsx)(n.td,{children:"Choose a method for authenticating with GitHub to enable auto-queue on pull requests."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions.property.targetBranches",children:"targetBranches"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"The branch names that we should auto-queue for."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonoptional--2",children:[(0,s.jsx)(n.code,{children:"runsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOn",id:"projen.github.AutoQueueOptions.property.runsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["ubuntu-latest"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner selection labels."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsongroupoptional--2",children:[(0,s.jsx)(n.code,{children:"runsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOnGroup",id:"projen.github.AutoQueueOptions.property.runsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner Group selection options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"allowedusernamesoptional--1",children:[(0,s.jsx)(n.code,{children:"allowedUsernames"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"allowedUsernames",id:"projen.github.AutoQueueOptions.property.allowedUsernames"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly allowedUsernames: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," pull requests from all users are eligible for auto-queuing"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Only pull requests authored by these Github usernames will have auto-queue enabled."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"labelsoptional-",children:[(0,s.jsx)(n.code,{children:"labels"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"labels",id:"projen.github.AutoQueueOptions.property.labels"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly labels: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," all pull requests are eligible for auto-queueing"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Only pull requests with one of this labels will have auto-queue enabled."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mergemethodoptional-",children:[(0,s.jsx)(n.code,{children:"mergeMethod"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mergeMethod",id:"projen.github.AutoQueueOptions.property.mergeMethod"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mergeMethod: MergeMethod;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergeMethod",children:"MergeMethod"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," MergeMethod.SQUASH"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The method used to add the PR to the merge queue Any branch protection rules must allow this merge method."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projencredentialsoptional-",children:[(0,s.jsx)(n.code,{children:"projenCredentials"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"projenCredentials",id:"projen.github.AutoQueueOptions.property.projenCredentials"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projenCredentials: GithubCredentials;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," uses credentials from the GitHub component"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Choose a method for authenticating with GitHub to enable auto-queue on pull requests."}),"\n",(0,s.jsx)(n.p,{children:"The workflow cannot use a default github token. Queuing a PR\nwith the default token will not trigger any merge queue workflows,\nwhich results in the PR just not getting merged at all."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://projen.io/

1docs/integrations/github/",children:"https://projen.io/docs/integrations/github/"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"targetbranchesoptional-",children:[(0,s.jsx)(n.code,{children:"targetBranches"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"targetBranches",id:"projen.github.AutoQueueOptions.property.targetBranches"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly targetBranches: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The branch names that we should auto-queue for."}),"\n",(0,s.jsxs)(n.p,{children:["This set of branches should be a subset of ",(0,s.jsx)(n.code,{children:"MergeQueueOptions.targetBranches"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["Be sure not to enable ",(0,s.jsx)(n.code,{children:"autoQueue"})," for branches that don't have branch rules\nwith merge requirements set up, otherwise new PRs will be merged\nimmediately after creating without a chance for review."]}),"\n",(0,s.jsx)(n.h2,{id:"automatically-merging-a-set-of-stacked-prs",children:"Automatically merging a set of Stacked PRs"}),"\n",(0,s.jsxs)(n.p,{children:["If you set this to ",(0,s.jsx)(n.code,{children:"['main']"})," you can automatically merge a set of Stacked PRs\nin the right order. It works like this:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Create PR #1 from branch ",(0,s.jsx)(n.code,{children:"a"}),", targeting ",(0,s.jsx)(n.code,{children:"main"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Create PR #2 from branch ",(0,s.jsx)(n.code,{children:"b"}),", targeting branch ",(0,s.jsx)(n.code,{children:"a"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Create PR #3 from branch ",(0,s.jsx)(n.code,{children:"c"}),", targeting branch ",(0,s.jsx)(n.code,{children:"b"}),"."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Initially, PR #1 will be set to auto-merge, PRs #2 and #3 will not."}),"\n",(0,s.jsxs)(n.p,{children:["Once PR #1 passes all of its requirements it will merge. That will delete\nbranch ",(0,s.jsx)(n.code,{children:"a"})," and change  the target branch of PR #2 change to ",(0,s.jsx)(n.code,{children:"main"}),". At that\npoint, auto-queueing will switch on for PR #2 and it gets merged, etc."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:["[!IMPORTANT]\nThis component will never disable AutoMerge, only enable it. So if a PR is\ninitially targeted at one of the branches in this list, and then\nsubsequently retargeted to another branch, ",(0,s.jsx)(n.em,{children:"AutoMerge is not\nautomatically turned off"}),"."]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"checkoutoptions-",children:["CheckoutOptions ",(0,s.jsx)(n.a,{name:"CheckoutOptions",id:"projen.github.CheckoutOptions"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--3",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.CheckoutOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst checkoutOptions: github.CheckoutOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--19",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.env",children:"env"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: string}"})}),(0,s.jsx)(n.td,{children:"Sets environment variables for steps to use in the runner environment."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.id",children:"id"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A unique identifier for the step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.if",children:"if"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"You can use the if conditional to prevent a job from running unless a condition is met."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A name for your step to display on GitHub."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.shell",children:"shell"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Overrides the default shell settings in the runner's operating system and the job's default."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.workingDirectory",children:"workingDirectory"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Specifies a working directory for a step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.background",children:"background"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Runs a step asynchronously so the job c

1ontinues to the next step without waiting for it to finish."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.cancel",children:"cancel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["Gracefully terminates a running background step, referenced by its ",(0,s.jsx)(n.code,{children:"id"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.continueOnError",children:"continueOnError"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Prevents a job from failing when a step fails."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.parallel",children:"parallel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Runs a group of steps concurrently, then waits for all of them to finish before continuing."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.timeoutMinutes",children:"timeoutMinutes"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"The maximum number of minutes to run the step before killing the process."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.wait",children:"wait"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsxs)(n.td,{children:["Pauses the job until one or more background steps complete. Provide the ",(0,s.jsx)(n.code,{children:"id"}),"s of the background steps to wait for."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.waitAll",children:"waitAll"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Pauses the job until all active background steps complete."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions.property.with",children:"with"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith",children:"CheckoutWith"})})}),(0,s.jsxs)(n.td,{children:["Options for ",(0,s.jsx)(n.code,{children:"checkout"}),"."]})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"envoptional--3",children:[(0,s.jsx)(n.code,{children:"env"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"env",id:"projen.github.CheckoutOptions.property.env"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly env: {[ key: string ]: string};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: string}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets environment variables for steps to use in the runner environment."}),"\n",(0,s.jsx)(n.p,{children:"You can also set environment variables for the entire workflow or a job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"idoptional-",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.CheckoutOptions.property.id"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly id: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A unique identifier for the step."}),"\n",(0,s.jsx)(n.p,{children:"You can use the id to reference the\nstep in contexts."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"ifoptional--1",children:[(0,s.jsx)(n.code,{children:"if"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"if",id:"projen.github.CheckoutOptions.property.if"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly if: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"You can use the if conditional to prevent a job from running unless a condition is met."}

1),"\n",(0,s.jsx)(n.p,{children:"You can use any supported context and expression to\ncreate a conditional."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"nameoptional--1",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.CheckoutOptions.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A name for your step to display on GitHub."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"shelloptional-",children:[(0,s.jsx)(n.code,{children:"shell"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"shell",id:"projen.github.CheckoutOptions.property.shell"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly shell: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Overrides the default shell settings in the runner's operating system and the job's default."}),"\n",(0,s.jsx)(n.p,{children:"Refer to GitHub documentation for allowed values."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workingdirectoryoptional-",children:[(0,s.jsx)(n.code,{children:"workingDirectory"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"workingDirectory",id:"projen.github.CheckoutOptions.property.workingDirectory"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workingDirectory: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies a working directory for a step."}),"\n",(0,s.jsx)(n.p,{children:"Overrides a job's working directory."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"backgroundoptional-",children:[(0,s.jsx)(n.code,{children:"background"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"background",id:"projen.github.CheckoutOptions.property.background"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly background: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Runs a step asynchronously so the job continues to the next step without waiting for it to finish."}),"\n",(0,s.jsx)(n.p,{children:"Use for long-running processes, such as\ndatabases, servers, or monitoring tasks, that need to run alongside other\nsteps."}),"\n",(0,s.jsxs)(n.p,{children:["Synchronize with background steps later using ",(0,s.jsx)(n.code,{children:"wait"})," or ",(0,s.jsx)(n.code,{children:"waitAll"}),", or\nstop them with ",(0,s.jsx)(n.code,{children:"cancel"}),". Give the step an ",(0,s.jsx)(n.code,{children:"id"})," so it can be referenced."]}),"\n",(0,s.jsx)(n.p,{children:"A maximum of 10 background steps can run concurrently in a single job;\nadditional background steps are queued until a slot is free."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsbackground",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsbackground"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"canceloptional-",children:[(0,s.jsx)(n.code,{children:"cancel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"cancel",id:"projen.github.CheckoutOptions.property.cancel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly cancel: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Gracefully terminates a running background step, referenced by its ",(0,s.jsx)(n.code,{children:"id"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"The runner sends the step's process a termination signal (SIGTERM) so it\ncan clean up, and forcibly stops it (SIGKILL) if it does not exit within\na short grace peri

1od."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepscancel",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepscancel"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"continueonerroroptional--1",children:[(0,s.jsx)(n.code,{children:"continueOnError"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"continueOnError",id:"projen.github.CheckoutOptions.property.continueOnError"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly continueOnError: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Prevents a job from failing when a step fails."}),"\n",(0,s.jsx)(n.p,{children:"Set to true to allow a job\nto pass when this step fails."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"paralleloptional-",children:[(0,s.jsx)(n.code,{children:"parallel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"parallel",id:"projen.github.CheckoutOptions.property.parallel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly parallel: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Runs a group of steps concurrently, then waits for all of them to finish before continuing."}),"\n",(0,s.jsxs)(n.p,{children:["This is shorthand for declaring each step with\n",(0,s.jsx)(n.code,{children:"background: true"})," followed by a ",(0,s.jsx)(n.code,{children:"wait"})," step."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this when you have a self-contained group of independent steps that\ncan all run at the same time and don't need to be referenced\nindividually. Use ",(0,s.jsx)(n.code,{children:"background"})," instead when you need finer control, such\nas starting a long-running process that stays up while later steps run."]}),"\n",(0,s.jsx)(n.p,{children:"Each step in the group is subject to the same 10-step concurrency limit\nas other background steps. Cannot be used inside a composite action."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsparallel",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsparallel"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"timeoutminutesoptional--1",children:[(0,s.jsx)(n.code,{children:"timeoutMinutes"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"timeoutMinutes",id:"projen.github.CheckoutOptions.property.timeoutMinutes"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly timeoutMinutes: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The maximum number of minutes to run the step before killing the process."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"waitoptional-",children:[(0,s.jsx)(n.code,{children:"wait"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"wait",id:"projen.github.CheckoutOptions.property.wait"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly wait: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Pauses the job until one or more background steps complete. Provide the ",(0,s.jsx)(n.code,{children:"id"}),"s of the background steps to wait for."]}),"\n",(0,s.jsxs)(n.p,{children:["This step performs no work itself; it only blocks until the referenced\nbackground steps finish. If a referenced background step failed, the\n",(0,s.jsx)(n.code,{children:"wait"})," step fails too."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"waitalloptional-",children:[(0,s.jsx)(n.code,{children:"waitAll"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"waitAll",id:"projen.github.CheckoutOptions.property.waitAll"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly waitAll: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Pauses the job until all active background steps complete."}),"\n",(0,s.jsxs)(n.p,{children:["Fails if any\nof the background steps it waits on failed, unless ",(0,s.jsx)(n.code,{children:"continueOnError"})," is\nset on this step."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait-all",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait-all"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"withoptional-",children:[(0,s.jsx)(n.code,{children:"with"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.CheckoutOptions.property.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly with: CheckoutWith;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith",children:"CheckoutWith"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"checkout"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"checkoutwith-",children:["CheckoutWith ",(0,s.jsx)(n.a,{name:"CheckoutWith",id:"projen.github.CheckoutWith"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"checkout"}),"."]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--4",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.CheckoutWith.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst checkoutWith: github.CheckoutWith = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--20",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith.property.fetchDepth",children:"fetchDepth"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Number of commits to fetch."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith.property.lfs",children:"lfs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether LFS is enabled for the GitHub repository."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith.property.path",children:"path"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Relative path under $GITHUB_WORKSPACE to place the repository."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith.property.ref",children:"ref"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Branch or tag name."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith.property.repository",children:"repository"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The repository (owner/repo) to use."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith.property.submodules",children:"submodules"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})})}),(0,s.jsx)(n.td,{children:"Whether to checkout Git submodules."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith.property.token",children:"token"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A GitHub token to use when checking out the repository."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"fetchdepthoptional-",children:[(0,s.jsx)(n.code,{children:"fetchDepth"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"fetchDepth",id:"projen.github.CheckoutWith.property.fetchDepth"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly fetchDepth: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," 1"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Number of commits to fetch."}),"\n",(0,s.jsx)(n.p,{children:"0 indicates all history for all branches and tags."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"lfsoptional-",children:[(0,s.jsx)(n.code,{children:"lfs"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"lfs",id:"projen.github.CheckoutWith.property.lfs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly lfs: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether LFS is enabled for the GitHub repository."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pathoptional-",children:[(0,s.jsx)(n.code,{children:"path"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"path",id:"projen.github.CheckoutWith.property.path"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly path: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," $GITHUB_WORKSPACE"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Relative path under $GITHUB_WORKSPACE to place the repository."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"refoptional-",children:[(0,s.jsx)(n.code,{children:"ref"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"ref",id:"projen.github.CheckoutWith.property.ref"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ref: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," the default branch is implicitly used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Branch or tag name."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"repositoryoptional-",children:[(0,s.jsx)(n.code,{children:"repository"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"repository",id:"projen.github.CheckoutWith.property.repository"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly repository: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," the default repository is implicitly used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The repository (owner/repo) to use."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"submodulesoptional-",children:[(0,s.jsx)(n.code,{children:"submodules"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"submodules",id:"projen.github.CheckoutWith.property.submodules"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly submodules: CheckoutSubmodules;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," CheckoutSubmodules.DISABLED"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to checkout Git submodules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tokenoptional-",children:[(0,s.jsx)(n.code,{children:"token"}),(0,s.jsx)(n.sup,{children:"Optional"}

1)," ",(0,s.jsx)(n.a,{name:"token",id:"projen.github.CheckoutWith.property.token"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly token: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," the default GITHUB_TOKEN is implicitly used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A GitHub token to use when checking out the repository."}),"\n",(0,s.jsxs)(n.p,{children:["If the intent is to push changes back to the branch, then you must use a\nPAT with ",(0,s.jsx)(n.code,{children:"repo"})," (and possibly ",(0,s.jsx)(n.code,{children:"workflows"}),") permissions."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"checkoutwithpatchoptions-",children:["CheckoutWithPatchOptions ",(0,s.jsx)(n.a,{name:"CheckoutWithPatchOptions",id:"projen.github.CheckoutWithPatchOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"checkoutWithPatch"}),"."]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--5",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.CheckoutWithPatchOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst checkoutWithPatchOptions: github.CheckoutWithPatchOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--21",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWithPatchOptions.property.fetchDepth",children:"fetchDepth"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Number of commits to fetch."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWithPatchOptions.property.lfs",children:"lfs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether LFS is enabled for the GitHub repository."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWithPatchOptions.property.path",children:"path"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Relative path under $GITHUB_WORKSPACE to place the repository."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWithPatchOptions.property.ref",children:"ref"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Branch or tag name."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWithPatchOptions.property.repository",children:"repository"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The repository (owner/repo) to use."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWithPatchOptions.property.submodules",children:"submodules"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})})}),(0,s.jsx)(n.td,{children:"Whether to checkout Git submodules."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWithPatchOptions.property.token",children:"token"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A GitHub token to use when checking out the repository."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWithPatchOptions.property.patchFile",children:"patchFile"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the artifact the patch is stored as."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"fetchdepthoptional--1",children:[(0,s.jsx)(n.code,{children:"fetchDepth"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"fetchDepth",id:"projen.github.CheckoutWithPatchOptions.property.fetchDepth"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly fetchDepth: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," 1"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Number of commits to fetch."}),"\n",(0,s.jsx)(n.p,{children:"0 indicates all history for all branches and tags."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"lfsoptional--1",children:[(0,s.jsx)(n.code,{children:"lfs"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"lfs",id:"projen.github.CheckoutWithPatchOptions.property.lfs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly lfs: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether LFS is enabled for the GitHub repository."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pathoptional--1",children:[(0,s.jsx)(n.code,{children:"path"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"path",id:"projen.github.CheckoutWithPatchOptions.property.path"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly path: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," $GITHUB_WORKSPACE"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Relative path under $GITHUB_WORKSPACE to place the repository."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"refoptional--1",children:[(0,s.jsx)(n.code,{children:"ref"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"ref",id:"projen.github.CheckoutWithPatchOptions.property.ref"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ref: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," the default branch is implicitly used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Branch or tag name."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"repositoryoptional--1",children:[(0,s.jsx)(n.code,{children:"repository"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"repository",id:"projen.github.CheckoutWithPatchOptions.property.repository"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly repository: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," the default repository is implicitly used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The repository (owner/repo) to use."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"submodulesoptional--1",children:[(0,s.jsx)(n.code,{children:"submodules"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"submodules",id:"projen.github.CheckoutWithPatchOptions.property.submodules"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly submodules: CheckoutSubmodules;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," CheckoutSubmodules.DISABLED"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to checkout Git submodules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tokenoptional--1",children:[(0,s.jsx)(n.code,{children:"token"}),(0,s.jsx)(n.sup,{children:"Optional"}

1)," ",(0,s.jsx)(n.a,{name:"token",id:"projen.github.CheckoutWithPatchOptions.property.token"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly token: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," the default GITHUB_TOKEN is implicitly used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A GitHub token to use when checking out the repository."}),"\n",(0,s.jsxs)(n.p,{children:["If the intent is to push changes back to the branch, then you must use a\nPAT with ",(0,s.jsx)(n.code,{children:"repo"})," (and possibly ",(0,s.jsx)(n.code,{children:"workflows"}),") permissions."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"patchfileoptional-",children:[(0,s.jsx)(n.code,{children:"patchFile"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"patchFile",id:"projen.github.CheckoutWithPatchOptions.property.patchFile"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly patchFile: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ".repo.patch"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the artifact the patch is stored as."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"concurrencyoptions-",children:["ConcurrencyOptions ",(0,s.jsx)(n.a,{name:"ConcurrencyOptions",id:"projen.github.ConcurrencyOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"concurrency"}),"."]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--6",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.ConcurrencyOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst concurrencyOptions: github.ConcurrencyOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--22",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ConcurrencyOptions.property.cancelInProgress",children:"cancelInProgress"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"When a workflow is triggered while another one (in the same group) is running, should GitHub cancel the running workflow?"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ConcurrencyOptions.property.group",children:"group"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Concurrency group controls which workflow runs will share the same concurrency limit."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"cancelinprogressoptional-",children:[(0,s.jsx)(n.code,{children:"cancelInProgress"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"cancelInProgress",id:"projen.github.ConcurrencyOptions.property.cancelInProgress"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly cancelInProgress: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"When a workflow is triggered while another one (in the same group) is running, should GitHub cancel the running workflow?"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"groupoptional-",children:[(0,s.jsx)(n.code,{children:"group"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"group",id:"projen.github.ConcurrencyOptions.property.group"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly group: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," ${{ github.workflow }}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Concurrency group controls which w

1orkflow runs will share the same concurrency limit."}),"\n",(0,s.jsxs)(n.p,{children:["For example, if you specify ",(0,s.jsx)(n.code,{children:"${{ github.workflow }}-${{ github.ref }}"}),", workflow runs triggered\non the same branch cannot run concurrently, but workflows runs triggered on different branches can."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-concurrency#example-concurrency-groups",children:"https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-concurrency#example-concurrency-groups"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"contributorstatementoptions-",children:["ContributorStatementOptions ",(0,s.jsx)(n.a,{name:"ContributorStatementOptions",id:"projen.github.ContributorStatementOptions"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for requiring a contributor statement on Pull Requests."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--7",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.ContributorStatementOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst contributorStatementOptions: github.ContributorStatementOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--23",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ContributorStatementOptions.property.exemptLabels",children:"exemptLabels"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Pull requests with one of these labels are exempted from a contributor statement."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ContributorStatementOptions.property.exemptUsers",children:"exemptUsers"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Pull requests from these GitHub users are exempted from a contributor statement."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"exemptlabelsoptional-",children:[(0,s.jsx)(n.code,{children:"exemptLabels"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"exemptLabels",id:"projen.github.ContributorStatementOptions.property.exemptLabels"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly exemptLabels: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no labels are excluded"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Pull requests with one of these labels are exempted from a contributor statement."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"exemptusersoptional-",children:[(0,s.jsx)(n.code,{children:"exemptUsers"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"exemptUsers",id:"projen.github.ContributorStatementOptions.property.exemptUsers"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly exemptUsers: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no users are exempted"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Pull requests from these GitHub users are exempted from a contributor statement."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"createpullrequestoptions-",children:["CreatePullRequestOptions ",(0,s.jsx)(n.a,{name:"CreatePullRequestOptions",id:"projen.github.CreatePullRequestOptions"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--8",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.CreatePullRequestOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst createPullRequestOptions: github.CreatePullRequestOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--24",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.pullRequestDescription",children:"pullRequestDescription"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Description added to the pull request."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.pullRequestTitle",children:"pullRequestTitle"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The full title used to create the pull request."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.workflowName",children:"workflowName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the workflow that will create the PR."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.addPaths",children:"addPaths"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsxs)(n.td,{children:["Paths to add to the commit, mapping to the action's ",(0,s.jsx)(n.code,{children:"add-paths"})," input."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.assignees",children:"assignees"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Assignees to add on the PR."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.baseBranch",children:"baseBranch"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Sets the pull request base branch."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.branchName",children:"branchName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The pull request branch name."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.credentials",children:"credentials"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})})}),(0,s.jsx)(n.td,{children:"The job credentials used to create the pull request."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.deleteBranch",children:"deleteBranch"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsxs)(n.td,{children:["Whether to delete the pull request branch when the pull request is closed, mapping to the action's ",(0,s.jsx)(n.code,{children:"delete-branch"})," input."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.gitIdentity",children:"gitIdentity"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity",children:"GitIdentity"})})}),(0,s.jsx)(n.td,{children:"The git identity used to create the commit."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.labels",children:"labels"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Labels to apply on the PR."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.signoff",children:"signoff"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}

1),(0,s.jsx)(n.td,{children:"Add Signed-off-by line by the committer at the end of the commit log message."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.stepId",children:"stepId"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The step ID which produces the output which indicates if a patch was created."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions.property.stepName",children:"stepName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the step displayed on GitHub."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pullrequestdescriptionrequired-",children:[(0,s.jsx)(n.code,{children:"pullRequestDescription"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"pullRequestDescription",id:"projen.github.CreatePullRequestOptions.property.pullRequestDescription"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly pullRequestDescription: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Description added to the pull request."}),"\n",(0,s.jsx)(n.p,{children:"Providence information are automatically added."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pullrequesttitlerequired-",children:[(0,s.jsx)(n.code,{children:"pullRequestTitle"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"pullRequestTitle",id:"projen.github.CreatePullRequestOptions.property.pullRequestTitle"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly pullRequestTitle: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The full title used to create the pull request."}),"\n",(0,s.jsx)(n.p,{children:"If PR titles are validated in this repo, the title should comply with the respective rules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workflownamerequired-",children:[(0,s.jsx)(n.code,{children:"workflowName"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"workflowName",id:"projen.github.CreatePullRequestOptions.property.workflowName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workflowName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the workflow that will create the PR."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addpathsoptional-",children:[(0,s.jsx)(n.code,{children:"addPaths"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"addPaths",id:"projen.github.CreatePullRequestOptions.property.addPaths"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly addPaths: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," all paths"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Paths to add to the commit, mapping to the action's ",(0,s.jsx)(n.code,{children:"add-paths"})," input."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"assigneesoptional-",children:[(0,s.jsx)(n.code,{children:"assignees"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"assignees",id:"projen.github.CreatePullRequestOptions.property.assignees"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly assignees: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no assignees"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Assignees to add on the PR."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"basebranchoptional-",children:[(0,s.jsx)(n.code,{children:"baseBranch"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"baseBranch",id:"projen.github.CreatePullRequestOptions.property.baseBranch"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly baseBranch: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," The branch checked out in the workflow."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets the pull request base branch."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"branchnameoptional-",children:[(0,s.jsx)(n.code,{children:"branchName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"branchName",id:"projen.github.CreatePullRequestOptions.property.branchName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly branchName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," ",(0,s.jsx)(n.code,{children:"github-actions/${options.workflowName}"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The pull request branch name."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"credentialsoptional-",children:[(0,s.jsx)(n.code,{children:"credentials"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"credentials",id:"projen.github.CreatePullRequestOptions.property.credentials"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly credentials: GithubCredentials;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job credentials used to create the pull request."}),"\n",(0,s.jsx)(n.p,{children:"Provided credentials must have permissions to create a pull request on the repository."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"deletebranchoptional-",children:[(0,s.jsx)(n.code,{children:"deleteBranch"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"deleteBranch",id:"projen.github.CreatePullRequestOptions.property.deleteBranch"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly deleteBranch: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to delete the pull request branch when the pull request is closed, mapping to the action's ",(0,s.jsx)(n.code,{children:"delete-branch"})," input."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitidentityoptional-",children:[(0,s.jsx)(n.code,{children:"gitIdentity"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"gitIdentity",id:"projen.github.CreatePullRequestOptions.property.gitIdentity"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitIdentity: GitIdentity;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity",children:"GitIdentity"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default GitHub Actions user"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The git identity used to create the commit."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"labelsoptional--1",children:[(0,s.jsx)(n.code,{children:"labels"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"labels",id:"projen.github.CreatePullRequestOptions.property.labels"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly labels: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no labels."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Labels to apply on the PR."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"signoffoptional-",children:[(0,s.jsx)(n.code,{children:"signoff"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"signoff",id:"projen.github.CreatePullRequestOptions.property.signoff"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly signoff: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}

1),"\n",(0,s.jsx)(n.p,{children:"Add Signed-off-by line by the committer at the end of the commit log message."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"stepidoptional-",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.CreatePullRequestOptions.property.stepId"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly stepId: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "create_pr"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step ID which produces the output which indicates if a patch was created."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"stepnameoptional-",children:[(0,s.jsx)(n.code,{children:"stepName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"stepName",id:"projen.github.CreatePullRequestOptions.property.stepName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly stepName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "Create Pull Request"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the step displayed on GitHub."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotallow-",children:["DependabotAllow ",(0,s.jsx)(n.a,{name:"DependabotAllow",id:"projen.github.DependabotAllow"})]}),"\n",(0,s.jsxs)(n.p,{children:["You can use the ",(0,s.jsx)(n.code,{children:"allow"})," option to customize which dependencies are updated."]}),"\n",(0,s.jsx)(n.p,{children:"The allow option supports the following options."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--9",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.DependabotAllow.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst dependabotAllow: github.DependabotAllow = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--25",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotAllow.property.dependencyName",children:"dependencyName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["Use to allow updates for dependencies with matching names, optionally using ",(0,s.jsx)(n.code,{children:"*"})," to match zero or more characters."]})]})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"dependencynamerequired--2",children:[(0,s.jsx)(n.code,{children:"dependencyName"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"dependencyName",id:"projen.github.DependabotAllow.property.dependencyName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly depen

1dencyName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Use to allow updates for dependencies with matching names, optionally using ",(0,s.jsx)(n.code,{children:"*"})," to match zero or more characters."]}),"\n",(0,s.jsxs)(n.p,{children:["For Java dependencies, the format of the dependency-name attribute is:\n",(0,s.jsx)(n.code,{children:"groupId:artifactId"}),", for example: ",(0,s.jsx)(n.code,{children:"org.kohsuke:github-api"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotcooldown-",children:["DependabotCooldown ",(0,s.jsx)(n.a,{name:"DependabotCooldown",id:"projen.github.DependabotCooldown"})]}),"\n",(0,s.jsx)(n.p,{children:"Defines a cooldown period for dependency version updates."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#cooldown-",children:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#cooldown-"})}),"\n"]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--10",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.DependabotCooldown.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst dependabotCooldown: github.DependabotCooldown = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--26",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotCooldown.property.defaultDays",children:"defaultDays"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Default cooldown period (in days) for all dependencies without specific semver rules."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotCooldown.property.exclude",children:"exclude"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"List of dependencies excluded from cooldown."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotCooldown.property.include",children:"include"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"List of dependencies to apply cooldown to."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotCooldown.property.semverMajorDays",children:"semverMajorDays"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Cooldown period (in days) for major version updates."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotCooldown.property.semverMinorDays",children:"semverMinorDays"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Cooldown period (in days) for minor version updates."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotCooldown.property.semverPatchDays",children:"semverPatchDays"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Cooldown period (in days) for patch version updates."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"defaultdaysoptional-",children:[(0,s.jsx)(n.code,{children:"defaultDays"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"defaultDays",id:"projen.github.DependabotCooldown.property.defaultDays"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly defaultDays: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no default cooldown"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default cooldown period (in days) for all dependencies without specific semver rules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"excludeoptional-",children:[(0,s.jsx)(n.code,{children:"exclude"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"exclude",id:"projen.github.DependabotCooldown.property.exclude"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly exclude: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no exclusions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"List of dependencies excluded from cooldown."}),"\n",(0,s.jsxs)(n.p,{children:["Supports wildcards.\nTakes precedence over ",(0,s.jsx)(n.code,{children:"include"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"includeoptional-",children:[(0,s.jsx)(n.code,{children:"include"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"include",id:"projen.github.DependabotCooldown.property.include"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly include: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," all dependencies"]}

1),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"List of dependencies to apply cooldown to."}),"\n",(0,s.jsx)(n.p,{children:"Supports wildcards."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"semvermajordaysoptional-",children:[(0,s.jsx)(n.code,{children:"semverMajorDays"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"semverMajorDays",id:"projen.github.DependabotCooldown.property.semverMajorDays"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly semverMajorDays: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," uses defaultDays"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Cooldown period (in days) for major version updates."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"semverminordaysoptional-",children:[(0,s.jsx)(n.code,{children:"semverMinorDays"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"semverMinorDays",id:"projen.github.DependabotCooldown.property.semverMinorDays"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly semverMinorDays: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," uses defaultDays"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Cooldown period (in days) for minor version updates."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"semverpatchdaysoptional-",children:[(0,s.jsx)(n.code,{children:"semverPatchDays"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"semverPatchDays",id:"projen.github.DependabotCooldown.property.semverPatchDays"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly semverPatchDays: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," uses defaultDays"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Cooldown period (in days) for patch version updates."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotgroup-",children:["DependabotGroup ",(0,s.jsx)(n.a,{name:"DependabotGroup",id:"projen.github.DependabotGroup"})]}),"\n",(0,s.jsx)(n.p,{children:"Defines a single group for dependency updates."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#groups--",children:"https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#groups--"})}),"\n"]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--11",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.DependabotGroup.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst dependabotGroup: github.DependabotGroup = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--27",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroup.property.patterns",children:"patterns"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Define a list of strings (with or without wildcards) that will match package names to form this dependency group."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroup.property.appliesTo",children:"appliesTo"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupAppliesTo",children:"DependabotGroupAppliesTo"})})}),(0,s.jsx)(n.td,{children:"Specify which type of update the group a

1pplies to."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroup.property.dependencyType",children:"dependencyType"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupDependencyType",children:"DependabotGroupDependencyType"})})}),(0,s.jsx)(n.td,{children:"Limit the group to a type of dependency."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroup.property.excludePatterns",children:"excludePatterns"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Optionally you can use this to exclude certain dependencies from the group."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroup.property.updateTypes",children:"updateTypes"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupUpdateType",children:"DependabotGroupUpdateType"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Limit the group to one or more semantic versioning levels."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"patternsrequired-",children:[(0,s.jsx)(n.code,{children:"patterns"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"patterns",id:"projen.github.DependabotGroup.property.patterns"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly patterns: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Define a list of strings (with or without wildcards) that will match package names to form this dependency group."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"appliestooptional-",children:[(0,s.jsx)(n.code,{children:"appliesTo"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"appliesTo",id:"projen.github.DependabotGroup.property.appliesTo"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly appliesTo: DependabotGroupAppliesTo;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupAppliesTo",children:"DependabotGroupAppliesTo"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," version updates"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specify which type of update the group applies to."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"dependencytypeoptional-",children:[(0,s.jsx)(n.code,{children:"dependencyType"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"dependencyType",id:"projen.github.DependabotGroup.property.dependencyType"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly depen

1dencyType: DependabotGroupDependencyType;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupDependencyType",children:"DependabotGroupDependencyType"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," all types of dependencies"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Limit the group to a type of dependency."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#dependency-type-groups",children:"https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#dependency-type-groups"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"excludepatternsoptional-",children:[(0,s.jsx)(n.code,{children:"excludePatterns"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"excludePatterns",id:"projen.github.DependabotGroup.property.excludePatterns"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly excludePatterns: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Optionally you can use this to exclude certain dependencies from the group."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"updatetypesoptional-",children:[(0,s.jsx)(n.code,{children:"updateTypes"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"updateTypes",id:"projen.github.DependabotGroup.property.updateTypes"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly updateTypes: DependabotGroupUpdateType[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupUpdateType",children:"DependabotGroupUpdateType"}),"[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," all semantic versioning levels"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Limit the group to one or more semantic versioning levels."}),"\n",(0,s.jsx)(n.p,{children:"If specified, must contain at least one element and elements must be unique."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#update-types-groups",children:"https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#update-types-groups"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotignore-",children:["DependabotIgnore ",(0,s.jsx)(n.a,{name:"DependabotIgnore",id:"projen.github.DependabotIgnore"})]}),"\n",(0,s.jsxs)(n.p,{children:["You can use the ",(0,s.jsx)(n.code,{children:"ignore"})," option to customize which dependencies are updated."]}),"\n",(0,s.jsx)(n.p,{children:"The ignore option supports the following options."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--12",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.DependabotIgnore.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst dependabotIgnore: github.DependabotIgnore = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--28",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotIgnore.property.dependencyName",children:"dependencyName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["Use to ignore updates for dependencies with matching names, optionally using ",(0,s.jsx)(n.code,{children:"*"})," to match zero or more characters."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotIgnore.property.versions",children:"versions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Use to ignore specific versions or ranges of versions."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"dependencynamerequired--3",children:[(0,s.jsx)(n.code,{children:"dependencyName"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"dependencyName",id:"projen.github.DependabotIgnore.property.dependencyName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly depen

1dencyName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Use to ignore updates for dependencies with matching names, optionally using ",(0,s.jsx)(n.code,{children:"*"})," to match zero or more characters."]}),"\n",(0,s.jsxs)(n.p,{children:["For Java dependencies, the format of the dependency-name attribute is:\n",(0,s.jsx)(n.code,{children:"groupId:artifactId"}),", for example: ",(0,s.jsx)(n.code,{children:"org.kohsuke:github-api"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"versionsoptional-",children:[(0,s.jsx)(n.code,{children:"versions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"versions",id:"projen.github.DependabotIgnore.property.versions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly versions: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Use to ignore specific versions or ranges of versions."}),"\n",(0,s.jsxs)(n.p,{children:["If you want to\ndefine a range, use the standard pattern for the package manager (for\nexample: ",(0,s.jsx)(n.code,{children:"^1.0.0"})," for npm, or ",(0,s.jsx)(n.code,{children:"~> 2.0"})," for Bundler)."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotoptions-",children:["DependabotOptions ",(0,s.jsx)(n.a,{name:"DependabotOptions",id:"projen.github.DependabotOptions"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--13",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.DependabotOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst dependabotOptions: github.DependabotOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--29",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.allow",children:"allow"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.DependabotAllow",children:"DependabotAllow"}),"[]"]})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#allow",children:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#allow"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.assignees",children:"assignees"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Specify individual assignees or teams of assignees for all pull requests raised for a package manager."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.cooldown",children:"cooldown"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotCooldown",children:"DependabotCooldown"})})}),(0,s.jsx)(n.td,{children:"Defines a cooldown period for dependency version updates."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.groups",children:"groups"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["{[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroup",children:"DependabotGroup"}),"}"]})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups",children:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.ignore",children:"ignore"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.DependabotIgnore",children:"DependabotIgnore"}),"[]"]})}),(0,s.jsxs)(n.td,{children:["You can use the ",(0,s.jsx)(n.code,{children:"ignore"}

1)," option to customize which dependencies are updated."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.ignoreProjen",children:"ignoreProjen"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsxs)(n.td,{children:["Ignores updates to ",(0,s.jsx)(n.code,{children:"projen"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.labels",children:"labels"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"List of labels to apply to the created PR's."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.openPullRequestsLimit",children:"openPullRequestsLimit"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Sets the maximum of pull requests Dependabot opens for version updates."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.registries",children:"registries"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["{[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistry",children:"DependabotRegistry"}),"}"]})}),(0,s.jsx)(n.td,{children:"Map of package registries to use."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.reviewers",children:"reviewers"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Specify individual reviewers or teams of reviewers for all pull requests raised for a package manager."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.scheduleInterval",children:"scheduleInterval"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotScheduleInterval",children:"DependabotScheduleInterval"})})}),(0,s.jsx)(n.td,{children:"How often to check for new versions and raise pull requests."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.targetBranch",children:"targetBranch"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#target-branch",children:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#target-branch"})," You can configure the target branch for raising pull requests for version updates against."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotOptions.property.versioningStrategy",children:"versioningStrategy"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.VersioningStrategy",children:"VersioningStrategy"})})}),(0,s.jsx)(n.td,{children:"The strategy to use when edits manifest and lock files."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"allowoptional-",children:[(0,s.jsx)(n.code,{children:"allow"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"allow",id:"projen.github.DependabotOptions.property.allow"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly allow: DependabotAllow[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotAllow",children:"DependabotAllow"}),"[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," []"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#allow",children:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#allow"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"Use the allow option to customize which depen

1dencies are updated. This\napplies to both version and security updates."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"assigneesoptional--1",children:[(0,s.jsx)(n.code,{children:"assignees"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"assignees",id:"projen.github.DependabotOptions.property.assignees"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly assignees: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," []"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specify individual assignees or teams of assignees for all pull requests raised for a package manager."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"cooldownoptional-",children:[(0,s.jsx)(n.code,{children:"cooldown"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"cooldown",id:"projen.github.DependabotOptions.property.cooldown"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly cooldown: DependabotCooldown;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotCooldown",children:"DependabotCooldown"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no cooldown"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Defines a cooldown period for dependency version updates."}),"\n",(0,s.jsx)(n.p,{children:"During the cooldown, Dependabot will not propose updates for a dependency.\nThis only applies to version updates, not security updates."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#cooldown-",children:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#cooldown-"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"groupsoptional-",children:[(0,s.jsx)(n.code,{children:"groups"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"groups",id:"projen.github.DependabotOptions.property.groups"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly groups: {[ key: string ]: DependabotGroup};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroup",children:"DependabotGroup"}),"}"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," []"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups",children:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"You can create groups to package dependency updates together into a single PR."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"ignoreoptional-",children:[(0,s.jsx)(n.code,{children:"ignore"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"ignore",id:"projen.github.DependabotOptions.property.ignore"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ignore: DependabotIgnore[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotIgnore",children:"DependabotIgnore"}),"[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," []"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["You can use the ",(0,s.jsx)(n.code,{children:"ignore"})," option to customize which dependencies are updated."]}),"\n",(0,s.jsx)(n.p,{children:"The ignore option supports the following options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"ignoreprojenoptional-",children:[(0,s.jsx)(n.code,{children:"ignoreProjen"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"ignoreProjen",id:"projen.github.DependabotOptions.property.ignoreProjen"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ignoreProjen: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Ignores updates to ",(0,s.jsx)(n.code,{children:"projen"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"This is required since projen updates may cause changes in committed files\nand anti-tamper checks will fail."}),"\n",(0,s.jsxs)(n.p,{children:["Projen upgrades are covered through the ",(0,s.jsx)(n.code,{children:"ProjenUpgrade"})," class."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"labelsoptional--2",children:[(0,s.jsx)(n.code,{children:"labels"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"labels",id:"projen.github.DependabotOptions.property.labels"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly labels: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"List of labels to apply to the created PR's."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"openpullrequestslimitoptional-",children:[(0,s.jsx)(n.code,{children:"openPullRequestsLimit"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"openPullRequestsLimit",id:"projen.github.DependabotOptions.property.openPullRequestsLimit"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly openPullRequestsLimit: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," 5"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets the maximum of pull requests Dependabot opens for version updates."}),"\n",(0,s.jsx)(n.p,{children:"Dependabot will not open any new requests until some of those open requests\nare merged or closed."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"registriesoptional-",children:[(0,s.jsx)(n.code,{children:"registries"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"registries",id:"projen.github.DependabotOptions.property.registries"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly registries: {[ key: string ]: DependabotRegistry};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistry",children:"DependabotRegistry"}),"}"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," use public registries"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Map of package registries to use."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"reviewersoptional-",children:[(0,s.jsx)(n.code,{children:"reviewers"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"reviewers",id:"projen.github.DependabotOptions.property.reviewers"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly reviewers: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," []"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specify individual reviewers or teams of reviewers for all pull requests raised for a package manager."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"scheduleintervaloptional-",children:[(0,s.jsx)(n.code,{children:"scheduleInterval"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"scheduleInterval",id:"projen.github.DependabotOptions.property.scheduleInterval"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly scheduleInterval: DependabotScheduleInterval;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotScheduleInterval",children:"DependabotScheduleInterval"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," ScheduleInterval.DAILY"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"How often to check for new versions and raise pull requests."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"targetbranchoptional-",children:[(0,s.jsx)(n.code,{children:"targetBranch"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"targetBranch",id:"projen.github.DependabotOptions.property.targetBranch"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly targetBranch: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#target-branch",children:"https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#target-branch"})," You can configure the target branch for raising pull requests for version updates against."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"versioningstrategyoptional-",children:[(0,s.jsx)(n.code,{children:"versioningStrategy"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"versioningStrategy",id:"projen.github.DependabotOptions.property.versioningStrategy"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly versioningStrategy: VersioningStrategy;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.VersioningStrategy",children:"VersioningStrategy"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," VersioningStrategy.LOCKFILE_ONLY The default is to only update the lock file because package.json is controlled by projen and any outside updates will fail the build."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The strategy to use when edits manifest and lock files."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotregistry-",children:["DependabotRegistry ",(0,s.jsx)(n.a,{name:"DependabotRegistry",id:"projen.github.DependabotRegistry"})]}),"\n",(0,s.jsx)(n.p,{children:"Use to add private registry support for dependabot."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#configuration-options-for-private-registries",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#configuration-options-for-private-registries"})}),"\n"]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--14",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.DependabotRegistry.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst dependabotRegistry: github.DependabotRegistry = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--30",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistry.property.type",children:"type"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType",children:"DependabotRegistryType"})})}),(0,s.jsx)(n.td,{children:"Registry type e.g. 'npm-registry' or 'docker-registry'."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistry.property.url",children:"url"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["Url for the registry e.g. '",(0,s.jsx)(n.a,{href:"https://npm.pkg.github.com",children:"https://npm.pkg.github.com"}),"' or 'registry.hub.docker.com'."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistry.property.key",children:"key"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}

1),(0,s.jsx)(n.td,{children:"A reference to a Dependabot secret containing an access key for this registry."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistry.property.organization",children:"organization"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Used with the hex-organization registry type."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistry.property.password",children:"password"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A reference to a Dependabot secret containing the password for the specified user."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistry.property.replacesBase",children:"replacesBase"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsxs)(n.td,{children:["For registries with type: python-index, if the boolean value is true, pip esolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default ",(0,s.jsx)(n.a,{href:"https://pypi.org/simple",children:"https://pypi.org/simple"}),")."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistry.property.token",children:"token"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Secret token for dependabot access e.g. '${{ secrets.DEPENDABOT_PACKAGE_TOKEN }}'."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistry.property.username",children:"username"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The username that Dependabot uses to access the registry."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"typerequired-",children:[(0,s.jsx)(n.code,{children:"type"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"type",id:"projen.github.DependabotRegistry.property.type"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly type: DependabotRegistryType;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType",children:"DependabotRegistryType"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Registry type e.g. 'npm-registry' or 'docker-registry'."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"urlrequired-",children:[(0,s.jsx)(n.code,{children:"url"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"url",id:"projen.github.DependabotRegistry.property.url"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly url: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Url for the registry e.g. '",(0,s.jsx)(n.a,{href:"https://npm.pkg.github.com",children:"https://npm.pkg.github.com"}),"' or 'registry.hub.docker.com'."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"keyoptional-",children:[(0,s.jsx)(n.code,{children:"key"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"key",id:"projen.github.DependabotRegistry.property.key"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly key: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," undefined"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A reference to a Dependabot secret containing an access key for this registry."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"organizationoptional-",children:[(0,s.jsx)(n.code,{children:"organization"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"organization",id:"projen.github.DependabotRegistry.property.organization"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly organization: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," undefined"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Used with the hex-organization registry type."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#hex-organization",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#hex-organization"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"passwordoptional-",children:[(0,s.jsx)(n.code,{children:"password"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"password",id:"projen.github.DependabotRegistry.property.password"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly password: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," undefined"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A reference to a Dependabot secret 

1containing the password for the specified user."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"replacesbaseoptional-",children:[(0,s.jsx)(n.code,{children:"replacesBase"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"replacesBase",id:"projen.github.DependabotRegistry.property.replacesBase"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly replacesBase: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," undefined"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["For registries with type: python-index, if the boolean value is true, pip esolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default ",(0,s.jsx)(n.a,{href:"https://pypi.org/simple",children:"https://pypi.org/simple"}),")."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tokenoptional--2",children:[(0,s.jsx)(n.code,{children:"token"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"token",id:"projen.github.DependabotRegistry.property.token"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly token: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," undefined"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Secret token for dependabot access e.g. '${{ secrets.DEPENDABOT_PACKAGE_TOKEN }}'."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"usernameoptional-",children:[(0,s.jsx)(n.code,{children:"username"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"username",id:"projen.github.DependabotRegistry.property.username"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly username: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," do not authenticate"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The username that Dependabot uses to access the registry."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependencyreviewoptions-",children:["DependencyReviewOptions ",(0,s.jsx)(n.a,{name:"DependencyReviewOptions",id:"projen.github.DependencyReviewOptions"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for the DependencyReview component."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--15",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.DependencyReviewOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst dependencyReviewOptions: github.DependencyReviewOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--31",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.runsOn",children:"runsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Github Runner selection labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.runsOnGroup",children:"runsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:"Github Runner Group selection options."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.allowGhsas",children:"allowGhsas"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"GitHub Advisory Database IDs that can be skipped during detection."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.allowLicenses",children:"allowLicenses"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"List of allowed SPDX license identifiers."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.commentSummaryInPr",children:"commentSummaryInPr"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Whether to post a comment summary on the PR."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.configFile",children:"configFile"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}

1),(0,s.jsx)(n.td,{children:"Path to an external configuration file."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.denyPackages",children:"denyPackages"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Packages to block in a PR (in purl format)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.failOnScopes",children:"failOnScopes"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Scopes of dependencies to fail on."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.failOnSeverity",children:"failOnSeverity"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The severity level at which the action will fail."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.licenseCheck",children:"licenseCheck"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Enable or disable the license check."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.showOpenSSFScorec

1ard",children:"showOpenSSFScorecard"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Show OpenSSF Scorecard scores for dependencies."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.vulnerabilityCheck",children:"vulnerabilityCheck"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Enable or disable the vulnerability check."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.warnOnly",children:"warnOnly"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"When true, the action will only warn and not fail."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions.property.warnOnOpenSSFScorecardLevel",children:"warnOnOpenSSFScorec

1ardLevel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Score threshold for OpenSSF Scorecard warnings."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonoptional--3",children:[(0,s.jsx)(n.code,{children:"runsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOn",id:"projen.github.DependencyReviewOptions.property.runsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["ubuntu-latest"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner selection labels."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsongroupoptional--3",children:[(0,s.jsx)(n.code,{children:"runsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOnGroup",id:"projen.github.DependencyReviewOptions.property.runsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner Group selection options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"allowghsasoptional-",children:[(0,s.jsx)(n.code,{children:"allowGhsas"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"allowGhsas",id:"projen.github.DependencyReviewOptions.property.allowGhsas"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly allowGhsas: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no advisories are skipped"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"GitHub Advisory Database IDs that can be skipped during detection."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"allowlicensesoptional-",children:[(0,s.jsx)(n.code,{children:"allowLicenses"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"allowLicenses",id:"projen.github.DependencyReviewOptions.property.allowLicenses"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly allowLicenses: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no license allow-list"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"List of allowed SPDX license identifiers."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"commentsummaryinproptional-",children:[(0,s.jsx)(n.code,{children:"commentSummaryInPr"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"commentSummaryInPr",id:"projen.github.DependencyReviewOptions.property.commentSummaryInPr"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly commentSummaryInPr: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "always"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to post a comment summary on the PR."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"configfileoptional-",children:[(0,s.jsx)(n.code,{children:"configFile"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"configFile",id:"projen.github.DependencyReviewOptions.property.configFile"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly configFile: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}

1)," no external config"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Path to an external configuration file."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"denypackagesoptional-",children:[(0,s.jsx)(n.code,{children:"denyPackages"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"denyPackages",id:"projen.github.DependencyReviewOptions.property.denyPackages"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly denyPackages: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no packages are denied"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Packages to block in a PR (in purl format)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"failonscopesoptional-",children:[(0,s.jsx)(n.code,{children:"failOnScopes"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"failOnScopes",id:"projen.github.DependencyReviewOptions.property.failOnScopes"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly failOnScopes: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' no scopes filter (action default is "runtime")']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Scopes of dependencies to fail on."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"failonseverityoptional-",children:[(0,s.jsx)(n.code,{children:"failOnSeverity"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"failOnSeverity",id:"projen.github.DependencyReviewOptions.property.failOnSeverity"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly failOnSeverity: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' no minimum severity (action default is "low")']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The severity level at which the action will fail."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"licensecheckoptional-",children:[(0,s.jsx)(n.code,{children:"licenseCheck"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"licenseCheck",id:"projen.github.DependencyReviewOptions.property.licenseCheck"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly licenseCheck: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Enable or disable the license check."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"showopenssfscorecardoptional-",children:[(0,s.jsx)(n.code,{children:"showOpenSSFScorec

1ard"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"showOpenSSFScorecard",id:"projen.github.DependencyReviewOptions.property.showOpenSSFScorecard"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly showOpenSSFScorecard: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Show OpenSSF Scorecard scores for dependencies."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"vulnerabilitycheckoptional-",children:[(0,s.jsx)(n.code,{children:"vulnerabilityCheck"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"vulnerabilityCheck",id:"projen.github.DependencyReviewOptions.property.vulnerabilityCheck"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly vulnerabilityCheck: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Enable or disable the vulnerability check."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"warnonlyoptional-",children:[(0,s.jsx)(n.code,{children:"warnOnly"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"warnOnly",id:"projen.github.DependencyReviewOptions.property.warnOnly"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly warnOnly: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"When true, the action will only warn and not fail."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"warnonopenssfscorecardleveloptional-",children:[(0,s.jsx)(n.code,{children:"warnOnOpenSSFScorec

1ardLevel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"warnOnOpenSSFScorecardLevel",id:"projen.github.DependencyReviewOptions.property.warnOnOpenSSFScorecardLevel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly warnOnOpenSSFScorecardLevel: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," 3"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Score threshold for OpenSSF Scorecard warnings."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"downloadartifactoptions-",children:["DownloadArtifactOptions ",(0,s.jsx)(n.a,{name:"DownloadArtifactOptions",id:"projen.github.DownloadArtifactOptions"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--16",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.DownloadArtifactOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst downloadArtifactOptions: github.DownloadArtifactOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--32",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.env",children:"env"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: string}"})}),(0,s.jsx)(n.td,{children:"Sets environment variables for steps to use in the runner environment."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.id",children:"id"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A unique identifier for the step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.if",children:"if"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"You can use the if conditional to prevent a job from running unless a condition is met."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A name for your step to display on GitHub."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.shell",children:"shell"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Overrides the default shell settings in the runner's operating system and the job's default."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.workingDirectory",children:"workingDirectory"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Specifies a working directory for a step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.background",children:"background"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Runs a step asynchronously so the job c

1ontinues to the next step without waiting for it to finish."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.cancel",children:"cancel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["Gracefully terminates a running background step, referenced by its ",(0,s.jsx)(n.code,{children:"id"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.continueOnError",children:"continueOnError"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Prevents a job from failing when a step fails."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.parallel",children:"parallel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Runs a group of steps concurrently, then waits for all of them to finish before continuing."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.timeoutMinutes",children:"timeoutMinutes"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"The maximum number of minutes to run the step before killing the process."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.wait",children:"wait"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsxs)(n.td,{children:["Pauses the job until one or more background steps complete. Provide the ",(0,s.jsx)(n.code,{children:"id"}),"s of the background steps to wait for."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.waitAll",children:"waitAll"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Pauses the job until all active background steps complete."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions.property.with",children:"with"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactWith",children:"DownloadArtifactWith"})})}),(0,s.jsxs)(n.td,{children:["Options for ",(0,s.jsx)(n.code,{children:"download-artifact"}),"."]})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"envoptional--4",children:[(0,s.jsx)(n.code,{children:"env"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"env",id:"projen.github.DownloadArtifactOptions.property.env"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly env: {[ key: string ]: string};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: string}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets environment variables for steps to use in the runner environment."}),"\n",(0,s.jsx)(n.p,{children:"You can also set environment variables for the entire workflow or a job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"idoptional--1",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.DownloadArtifactOptions.property.id"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly id: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A unique identifier for the step."}),"\n",(0,s.jsx)(n.p,{children:"You can use the id to reference the\nstep in contexts."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"ifoptional--2",children:[(0,s.jsx)(n.code,{children:"if"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"if",id:"projen.github.DownloadArtifactOptions.property.if"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly if: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"You can use the if conditional to prevent a job from running unless a condition is met."}

1),"\n",(0,s.jsx)(n.p,{children:"You can use any supported context and expression to\ncreate a conditional."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"nameoptional--2",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.DownloadArtifactOptions.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A name for your step to display on GitHub."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"shelloptional--1",children:[(0,s.jsx)(n.code,{children:"shell"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"shell",id:"projen.github.DownloadArtifactOptions.property.shell"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly shell: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Overrides the default shell settings in the runner's operating system and the job's default."}),"\n",(0,s.jsx)(n.p,{children:"Refer to GitHub documentation for allowed values."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workingdirectoryoptional--1",children:[(0,s.jsx)(n.code,{children:"workingDirectory"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"workingDirectory",id:"projen.github.DownloadArtifactOptions.property.workingDirectory"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workingDirectory: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies a working directory for a step."}),"\n",(0,s.jsx)(n.p,{children:"Overrides a job's working directory."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"backgroundoptional--1",children:[(0,s.jsx)(n.code,{children:"background"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"background",id:"projen.github.DownloadArtifactOptions.property.background"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly background: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Runs a step asynchronously so the job continues to the next step without waiting for it to finish."}),"\n",(0,s.jsx)(n.p,{children:"Use for long-running processes, such as\ndatabases, servers, or monitoring tasks, that need to run alongside other\nsteps."}),"\n",(0,s.jsxs)(n.p,{children:["Synchronize with background steps later using ",(0,s.jsx)(n.code,{children:"wait"})," or ",(0,s.jsx)(n.code,{children:"waitAll"}),", or\nstop them with ",(0,s.jsx)(n.code,{children:"cancel"}),". Give the step an ",(0,s.jsx)(n.code,{children:"id"})," so it can be referenced."]}),"\n",(0,s.jsx)(n.p,{children:"A maximum of 10 background steps can run concurrently in a single job;\nadditional background steps are queued until a slot is free."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsbackground",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsbackground"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"canceloptional--1",children:[(0,s.jsx)(n.code,{children:"cancel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"cancel",id:"projen.github.DownloadArtifactOptions.property.cancel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly cancel: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Gracefully terminates a running background step, referenced by its ",(0,s.jsx)(n.code,{children:"id"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"The runner sends the step's process a termination signal (SIGTERM) so it\ncan clean up, and forcibly stops it (SIGKILL) if it does not exit within\na short grace peri

1od."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepscancel",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepscancel"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"continueonerroroptional--2",children:[(0,s.jsx)(n.code,{children:"continueOnError"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"continueOnError",id:"projen.github.DownloadArtifactOptions.property.continueOnError"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly continueOnError: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Prevents a job from failing when a step fails."}),"\n",(0,s.jsx)(n.p,{children:"Set to true to allow a job\nto pass when this step fails."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"paralleloptional--1",children:[(0,s.jsx)(n.code,{children:"parallel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"parallel",id:"projen.github.DownloadArtifactOptions.property.parallel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly parallel: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Runs a group of steps concurrently, then waits for all of them to finish before continuing."}),"\n",(0,s.jsxs)(n.p,{children:["This is shorthand for declaring each step with\n",(0,s.jsx)(n.code,{children:"background: true"})," followed by a ",(0,s.jsx)(n.code,{children:"wait"})," step."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this when you have a self-contained group of independent steps that\ncan all run at the same time and don't need to be referenced\nindividually. Use ",(0,s.jsx)(n.code,{children:"background"})," instead when you need finer control, such\nas starting a long-running process that stays up while later steps run."]}),"\n",(0,s.jsx)(n.p,{children:"Each step in the group is subject to the same 10-step concurrency limit\nas other background steps. Cannot be used inside a composite action."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsparallel",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsparallel"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"timeoutminutesoptional--2",children:[(0,s.jsx)(n.code,{children:"timeoutMinutes"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"timeoutMinutes",id:"projen.github.DownloadArtifactOptions.property.timeoutMinutes"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly timeoutMinutes: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The maximum number of minutes to run the step before killing the process."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"waitoptional--1",children:[(0,s.jsx)(n.code,{children:"wait"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"wait",id:"projen.github.DownloadArtifactOptions.property.wait"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly wait: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Pauses the job until one or more background steps complete. Provide the ",(0,s.jsx)(n.code,{children:"id"}),"s of the background steps to wait for."]}),"\n",(0,s.jsxs)(n.p,{children:["This step performs no work itself; it only blocks until the referenced\nbackground steps finish. If a referenced background step failed, the\n",(0,s.jsx)(n.code,{children:"wait"})," step fails too."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"waitalloptional--1",children:[(0,s.jsx)(n.code,{children:"waitAll"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"waitAll",id:"projen.github.DownloadArtifactOptions.property.waitAll"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly waitAll: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Pauses the job until all active background steps complete."}),"\n",(0,s.jsxs)(n.p,{children:["Fails if any\nof the background steps it waits on failed, unless ",(0,s.jsx)(n.code,{children:"continueOnError"})," is\nset on this step."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait-all",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait-all"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"withrequired-",children:[(0,s.jsx)(n.code,{children:"with"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.DownloadArtifactOptions.property.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly with: DownloadArtifactWith;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactWith",children:"DownloadArtifactWith"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"download-artifact"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"downloadartifactwith-",children:["DownloadArtifactWith ",(0,s.jsx)(n.a,{name:"DownloadArtifactWith",id:"projen.github.DownloadArtifactWith"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--17",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.DownloadArtifactWith.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst downloadArtifactWith: github.DownloadArtifactWith = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--33",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactWith.property.artifactIds",children:"artifactIds"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"IDs of the artifacts to download."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactWith.property.mergeMultiple",children:"mergeMultiple"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"When multiple artifacts are matched, this changes the behavior of the destination directories If true, the downloaded artifacts will be in the same directory specified by path If false, the downloaded artifacts will be extracted into individual named directories within the specified path."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactWith.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Name of the artifact to download."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactWith.property.path",children:"path"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A file, directory or wildcard pattern that describes what to download."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactWith.property.pattern",children:"pattern"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A glob pattern to the artifacts that should be downloaded This is ignored if name is specified."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactWith.property.repository",children:"repository"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:'The repository owner and the repository name joined together by "/" If github-token is specified, this is the repository that artifacts will be downloaded from.'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactWith.property.runId",children:"runId"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The id of the workflow run where the desired download artifact was uploaded from If github-token is specified, this is the run that artifacts will be downloaded from."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactWith.property.token",children:"token"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The GitHub token used to authenticate with the GitHub API to download artifacts from a different repository or from a different workflow run."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"artifactidsoptional-",children:[(0,s.jsx)(n.code,{children:"artifactIds"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"artifactIds",id:"projen.github.DownloadArtifactWith.property.artifactIds"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly artifactIds: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"IDs of the artifacts to download."}),"\n",(0,s.jsxs)(n.p,{children:["Either inputs ",(0,s.jsx)(n.code,{children:"artifact-ids"})," or ",(0,s.jsx)(n.code,{children:"name"})," can be used, but not both."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mergemultipleoptional-",children:[(0,s.jsx)(n.code,{children:"mergeMultiple"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mergeMultiple",id:"projen.github.DownloadArtifactWith.property.mergeMultiple"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mergeMultiple: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"When multiple artifacts are matched, this changes the behavior of the destination directories If true, the downloaded artifacts will be in the same directory specified by path If false, the downloaded artifacts will be extracted into individual named directories within the specified path."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"nameoptional--3",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.DownloadArtifactWith.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," If unspecified, all artifacts for the run are downloaded"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Name of the artifact to download."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pathoptional--2",children:[(0,s.jsx)(n.code,{children:"path"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"path",id:"projen.github.DownloadArtifactWith.property.path"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly path: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," $GITHUB_WORKSPACE"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A file, directory or wildcard pattern that describes what to download."}),"\n",(0,s.jsx)(n.p,{children:"Supports basic tilde expansion."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"patternoptional-",children:[(0,s.jsx)(n.code,{children:"pattern"}),(0,s.jsx)(n.sup,{children:"Optional"}

1)," ",(0,s.jsx)(n.a,{name:"pattern",id:"projen.github.DownloadArtifactWith.property.pattern"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly pattern: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A glob pattern to the artifacts that should be downloaded This is ignored if name is specified."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"repositoryoptional--2",children:[(0,s.jsx)(n.code,{children:"repository"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"repository",id:"projen.github.DownloadArtifactWith.property.repository"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly repository: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," ${{ github.repository }}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'The repository owner and the repository name joined together by "/" If github-token is specified, this is the repository that artifacts will be downloaded from.'}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runidoptional-",children:[(0,s.jsx)(n.code,{children:"runId"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runId",id:"projen.github.DownloadArtifactWith.property.runId"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runId: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," ${{ github.run_id }}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The id of the workflow run where the desired download artifact was uploaded from If github-token is specified, this is the run that artifacts will be downloaded from."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tokenoptional--3",children:[(0,s.jsx)(n.code,{children:"token"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"token",id:"projen.github.DownloadArtifactWith.property.token"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly token: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," If unspecified, the action will download artifacts from the current repo and the current workflow run"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The GitHub token used to authenticate with the GitHub API to download artifacts from a different repository or from a different workflow run."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"githubcredentialsappoptions-",children:["GithubCredentialsAppOptions ",(0,s.jsx)(n.a,{name:"GithubCredentialsAppOptions",id:"projen.github.GithubCredentialsAppOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"GithubCredentials.fromApp"}),"."]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--18",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.GithubCredentialsAppOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst githubCredentialsAppOptions: github.GithubCredentialsAppOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--34",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentialsAppOptions.property.appIdSecret",children:"appIdSecret"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}

1),(0,s.jsx)(n.td,{children:"The secret containing the GitHub App ID."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentialsAppOptions.property.environment",children:"environment"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The GitHub Actions environment the secrets are added to."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentialsAppOptions.property.owner",children:"owner"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The owner of the GitHub App installation."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentialsAppOptions.property.permissions",children:"permissions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.AppPermissions",children:"AppPermissions"})})}),(0,s.jsx)(n.td,{children:"The permissions granted to the token."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentialsAppOptions.property.privateKeySecret",children:"privateKeySecret"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The secret containing the GitHub App private key."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentialsAppOptions.property.repositories",children:"repositories"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"List of repositories to grant access to."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"appidsecretoptional-",children:[(0,s.jsx)(n.code,{children:"appIdSecret"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"appIdSecret",id:"projen.github.GithubCredentialsAppOptions.property.appIdSecret"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly appIdSecret: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "PROJEN_APP_ID"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The secret containing the GitHub App ID."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"environmentoptional--1",children:[(0,s.jsx)(n.code,{children:"environment"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"environment",id:"projen.github.GithubCredentialsAppOptions.property.environment"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly environment: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no environment used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The GitHub Actions environment the secrets are added to."}),"\n",(0,s.jsx)(n.p,{children:"This can be used to add explicit approval steps to access the secrets."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"owneroptional-",children:[(0,s.jsx)(n.code,{children:"owner"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"owner",id:"projen.github.GithubCredentialsAppOptions.property.owner"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly owner: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," if empty, defaults to the current repository owner"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The owner of the GitHub App installation."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"permissionsoptional-",children:[(0,s.jsx)(n.code,{children:"permissions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"permissions",id:"projen.github.GithubCredentialsAppOptions.property.permissions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly permissions: AppPermissions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"}

1)," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.AppPermissions",children:"AppPermissions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," all permissions granted to the app"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The permissions granted to the token."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"privatekeysecretoptional-",children:[(0,s.jsx)(n.code,{children:"privateKeySecret"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"privateKeySecret",id:"projen.github.GithubCredentialsAppOptions.property.privateKeySecret"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly privateKeySecret: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "PROJEN_APP_PRIVATE_KEY"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The secret containing the GitHub App private key."}),"\n",(0,s.jsx)(n.p,{children:"Escaped newlines (\\n) will be automatically replaced with actual newlines."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"repositoriesoptional-",children:[(0,s.jsx)(n.code,{children:"repositories"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"repositories",id:"projen.github.GithubCredentialsAppOptions.property.repositories"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly repositories: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," if owner is set and repositories is empty, access will be scoped to all repositories in the provided repository owner's installation. If owner and repositories are empty, access will be scoped to only the current repository."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"List of repositories to grant access to."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"githubcredentialspersonalaccesstokenoptions-",children:["GithubCredentialsPersonalAccessTokenOptions ",(0,s.jsx)(n.a,{name:"GithubCredentialsPersonalAccessTokenOptions",id:"projen.github.GithubCredentialsPersonalAccessTokenOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"GithubCredentials.fromPersonalAccessToken"}),"."]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--19",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.GithubCredentialsPersonalAccessTokenOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst githubCredentialsPersonalAccessTokenOptions: github.GithubCredentialsPersonalAccessTokenOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--35",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentialsPersonalAccessTokenOptions.property.environment",children:"environment"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The GitHub Actions environment the secrets is added to."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentialsPersonalAccessTokenOptions.property.secret",children:"secret"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the secret that holds the GitHub personal access token."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"environmentoptional--2",children:[(0,s.jsx)(n.code,{children:"environment"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"environment",id:"projen.github.GithubCredentialsPersonalAccessTokenOptions.property.environment"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly environment: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no environment used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The GitHub Actions environment the secrets is added to."}),"\n",(0,s.jsx)(n.p,{children:"This can be used to add explicit approval steps to access the secret."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"secretoptional--1",children:[(0,s.jsx)(n.code,{children:"secret"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"secret",id:"projen.github.GithubCredentialsPersonalAccessTokenOptions.property.secret"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly secret: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "PROJEN_GITHUB_TOKEN"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the secret that holds the GitHub personal access token."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"githuboptions-",children:["GitHubOptions ",(0,s.jsx)(n.a,{name:"GitHubOptions",id:"projen.github.GitHubOptions"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--20",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.GitHubOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst gitHubOptions: github.GitHubOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--36",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.checkoutSubmodules",children:"checkoutSubmodules"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})})}),(0,s.jsx)(n.td,{children:"Whether to checkout Git submodules."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.dependencyReview",children:"dependencyReview"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Enable the dependency-review-action workflow on pull requests."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.dependencyReviewOptions",children:"dependencyReviewOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions",children:"DependencyReviewOptions"})})}),(0,s.jsx)(n.td,{children:"Options for the dependency review workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.downloadLfs",children:"downloadLfs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Download files in LFS in workflows."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.mergeQueue",children:"mergeQueue"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether a merge queue should be used on this repository to merge pull requests."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.mergeQueueOptions",children:"mergeQueueOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueueOptions",children:"MergeQueueOptions"})})}),(0,s.jsx)(n.td,{children:"Options for MergeQueue."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.mergify",children:"mergify"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether mergify should be enabled on this repository or not."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.mergifyOptions",children:"mergifyOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyOptions",children:"MergifyOptions"})})}),(0,s.jsx)(n.td,{children:"Options for Mergify."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.projenCredentials",children:"projenCredentials"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})})}),(0,s.jsx)(n.td,{children:"Choose a method of providing GitHub API access for projen workflows."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.pullRequestBackport",children:"pullRequestBackport"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Add a workflow that allows backport of PRs to other branches using labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.pullRequestBackportOptions",children:"pullRequestBackportOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions",children:"PullRequestBackportOptions"})})}

1),(0,s.jsx)(n.td,{children:"Options for configuring pull request backport."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.pullRequestLint",children:"pullRequestLint"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.pullRequestLintOptions",children:"pullRequestLintOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLintOptions",children:"PullRequestLintOptions"})})}),(0,s.jsx)(n.td,{children:"Options for configuring a pull request linter."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.workflowRunsOn",children:"workflowRunsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Github Runner selection labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.workflowRunsOnGroup",children:"workflowRunsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:"Github Runner Group selection options."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions.property.workflows",children:"workflows"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Enables GitHub workflows."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"checkoutsubmodulesoptional-",children:[(0,s.jsx)(n.code,{children:"checkoutSubmodules"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"checkoutSubmodules",id:"projen.github.GitHubOptions.property.checkoutSubmodules"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly checkoutSubmodules: CheckoutSubmodules;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," CheckoutSubmodules.DISABLED"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to checkout Git submodules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"dependencyreviewoptional-",children:[(0,s.jsx)(n.code,{children:"dependencyReview"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"dependencyReview",id:"projen.github.GitHubOptions.property.dependencyReview"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly depen

1dencyReview: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Enable the dependency-review-action workflow on pull requests."}),"\n",(0,s.jsxs)(n.p,{children:["Adds a separate workflow that runs ",(0,s.jsx)(n.code,{children:"actions/dependency-review-action"}),"\nto scan pull requests for newly introduced vulnerable or non-compliant\ndependencies."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"dependencyreviewoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"dependencyReviewOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"dependencyReviewOptions",id:"projen.github.GitHubOptions.property.dependencyReviewOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly dependencyReviewOptions: DependencyReviewOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DependencyReviewOptions",children:"DependencyReviewOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default options"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options for the dependency review workflow."}),"\n",(0,s.jsxs)(n.p,{children:["Only used when ",(0,s.jsx)(n.code,{children:"dependencyReview"})," is ",(0,s.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"downloadlfsoptional-",children:[(0,s.jsx)(n.code,{children:"downloadLfs"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"downloadLfs",id:"projen.github.GitHubOptions.property.downloadLfs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly downloadLfs: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true if the associated project has ",(0,s.jsx)(n.code,{children:"lfsPatterns"}),", ",(0,s.jsx)(n.code,{children:"false"})," otherwise"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Download files in LFS in workflows."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mergequeueoptional--1",children:[(0,s.jsx)(n.code,{children:"mergeQueue"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mergeQueue",id:"projen.github.GitHubOptions.property.mergeQueue"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mergeQueue: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether a merge queue should be used on this repository to merge pull requests."}),"\n",(0,s.jsx)(n.p,{children:"Requires additional configuration of the repositories branch protection rules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mergequeueoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"mergeQueueOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mergeQueueOptions",id:"projen.github.GitHubOptions.property.mergeQueueOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mergeQueueOptions: MergeQueueOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergeQueueOptions",children:"MergeQueueOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default options"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options for MergeQueue."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mergifyoptional--1",children:[(0,s.jsx)(n.code,{children:"mergify"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mergify",id:"projen.github.GitHubOptions.property.mergify"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mergify: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether mergify should be enabled on this repository or not."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mergifyoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"mergifyOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mergifyOptions",id:"projen.github.GitHubOptions.property.mergifyOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mergifyOptions: MergifyOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyOptions",children:"MergifyOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default options"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options for Mergify."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projencredentialsoptional--1",children:[(0,s.jsx)(n.code,{children:"projenCredentials"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"projenCredentials",id:"projen.github.GitHubOptions.property.projenCredentials"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projenCredentials: GithubCredentials;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," use a personal access token named PROJEN_GITHUB_TOKEN"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Choose a method of providing GitHub API access for projen workflows."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pullrequestbackportoptional-",children:[(0,s.jsx)(n.code,{children:"pullRequestBackport"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"pullRequestBackport",id:"projen.github.GitHubOptions.property.pullRequestBackport"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly pullRequestBackport: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Add a workflow that allows backport of PRs to other branches using labels."}),"\n",(0,s.jsx)(n.p,{children:"When opening a new PR add a backport label to it,\nand the PR will be backported to the target branches once the PR is merged."}),"\n",(0,s.jsx)(n.p,{children:"Should not be used together with mergify."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pullrequestbackportoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"pullRequestBackportOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"pullRequestBackportOptions",id:"projen.github.GitHubOptions.property.pullRequestBackportOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly pullRequestBackportOptions: PullRequestBackportOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions",children:"PullRequestBackportOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," see defaults in ",(0,s.jsx)(n.code,{children:"PullRequestBackportOptions"})]}),"\n"]}

1),"\n",(0,s.jsx)(n.p,{children:"Options for configuring pull request backport."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pullrequestlintoptional-",children:[(0,s.jsx)(n.code,{children:"pullRequestLint"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"pullRequestLint",id:"projen.github.GitHubOptions.property.pullRequestLint"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly pullRequestLint: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pullrequestlintoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"pullRequestLintOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"pullRequestLintOptions",id:"projen.github.GitHubOptions.property.pullRequestLintOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly pullRequestLintOptions: PullRequestLintOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLintOptions",children:"PullRequestLintOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," see defaults in ",(0,s.jsx)(n.code,{children:"PullRequestLintOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options for configuring a pull request linter."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workflowrunsonoptional-",children:[(0,s.jsx)(n.code,{children:"workflowRunsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"workflowRunsOn",id:"projen.github.GitHubOptions.property.workflowRunsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workflowRunsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["ubuntu-latest"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner selection labels."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workflowrunsongroupoptional-",children:[(0,s.jsx)(n.code,{children:"workflowRunsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"workflowRunsOnGroup",id:"projen.github.GitHubOptions.property.workflowRunsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workflowRunsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner Group selection options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workflowsoptional-",children:[(0,s.jsx)(n.code,{children:"workflows"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"workflows",id:"projen.github.GitHubOptions.property.workflows"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workflows: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Enables GitHub workflows."}),"\n",(0,s.jsxs)(n.p,{children:["If this is set to ",(0,s.jsx)(n.code,{children:"false"}),", workflows will not be created."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"githubprojectoptions-",children:["GitHubProjectOptions ",(0,s.jsx)(n.a,{name:"GitHubProjectOptions",id:"projen.github.GitHubProjectOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"GitHubProject"}),"."]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--21",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.GitHubProjectOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst gitHubProjectOptions: github.GitHubProjectOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--37",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"This is the name of your project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.commitGenerated",children:"commitGenerated"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether to commit the managed files by default."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.gitIgnoreOptions",children:"gitIgnoreOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.IgnoreFileOptions"})}),(0,s.jsx)(n.td,{children:"Configuration options for .gitignore file."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.gitOptions",children:"gitOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GitOptions"})}),(0,s.jsx)(n.td,{children:"Configuration options for git."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.logging",children:"logging"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.LoggerOptions"})}),(0,s.jsx)(n.td,{children:"Configure logging options such as verbosity."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.outdir",children:"outdir"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The root directory of the project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.parent",children:"parent"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Project"})}),(0,s.jsx)(n.td,{children:"The parent project, if this project is part of a bigger project."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.projectTree",children:"projectTree"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsxs)(n.td,{children:["Generate a project tree file (",(0,s.jsx)(n.code,{children:".projen/tree.json"}),") that shows all components and their relationships. Useful for understanding your project structure and debugging."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.projenCommand",children:"projenCommand"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The shell command to use in order to run the projen CLI."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.projenrcJson",children:"projenrcJson"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsxs)(n.td,{children:["Generate (once) .projenrc.json (in JSON). Set to ",(0,s.jsx)(n.code,{children:"false"})," in order to disable .projenrc.json generation."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.projenrcJsonOptions",children:"projenrcJsonOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.ProjenrcJsonOptions"})}),(0,s.jsx)(n.td,{children:"Options for .projenrc.json."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.renovatebot",children:"renovatebot"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Use renovatebot to handle dependency upgrades."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.renovatebotOptions",children:"renovatebotOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.RenovatebotOptions"})}),(0,s.jsx)(n.td,{children:"Options for renovatebot."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.autoApproveOptions",children:"autoApproveOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoApproveOptions",children:"AutoApproveOptions"})})}),(0,s.jsx)(n.td,{children:"Enable and configure the 'auto approve' workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.autoMerge",children:"autoMerge"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Enable automatic merging on GitHub."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.autoMergeOptions",children:"autoMergeOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoMergeOptions",children:"AutoMergeOptions"})})}),(0,s.jsx)(n.td,{children:"Configure options for automatic merging on GitHub."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.clobber",children:"clobber"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsxs)(n.td,{children:["Add a ",(0,s.jsx)(n.code,{children:"clobber"})," task which resets the repo to origin."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.devContainer",children:"devContainer"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Add a VSCode development environment (used for GitHub Codespaces)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.github",children:"github"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Enable GitHub integration."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.githubOptions",children:"githubOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions",children:"GitHubOptions"})})}),(0,s.jsx)(n.td,{children:"Options for GitHub integration."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.gitpod",children:"gitpod"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Add a Gitpod development environment."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.projenCredentials",children:"projenCredentials"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})})}),(0,s.jsx)(n.td,{children:"Choose a method of providing GitHub API access for projen workflows."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.readme",children:"readme"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.SampleReadmeProps"})}),(0,s.jsx)(n.td,{children:"The README setup."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.stale",children:"stale"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Auto-close of stale issues and pull request."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.staleOptions",children:"staleOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleOptions",children:"StaleOptions"})})}),(0,s.jsx)(n.td,{children:"Auto-close stale issues and pull requests."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubProjectOptions.property.vscode",children:"vscode"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Enable VSCode integration."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"namerequired--8",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.GitHubProjectOptions.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," $BASEDIR"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"This is the name of your project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"commitgeneratedoptional-",children:[(0,s.jsx)(n.code,{children:"commitGenerated"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"commitGenerated",id:"projen.github.GitHubProjectOptions.property.commitGenerated"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly commitGenerated: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to commit the managed files by default."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitignoreoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"gitIgnoreOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"gitIgnoreOptions",id:"projen.github.GitHubProjectOptions.property.gitIgnoreOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitIgnoreOptions: IgnoreFileOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,

1{children:"Type:"})," projen.IgnoreFileOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Configuration options for .gitignore file."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"gitOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"gitOptions",id:"projen.github.GitHubProjectOptions.property.gitOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitOptions: GitOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GitOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Configuration options for git."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"loggingoptional-",children:[(0,s.jsx)(n.code,{children:"logging"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"logging",id:"projen.github.GitHubProjectOptions.property.logging"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly logging: LoggerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.LoggerOptions"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," {}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Configure logging options such as verbosity."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"outdiroptional-",children:[(0,s.jsx)(n.code,{children:"outdir"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"outdir",id:"projen.github.GitHubProjectOptions.property.outdir"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly outdir: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "."']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The root directory of the project."}),"\n",(0,s.jsx)(n.p,{children:"Relative to this directory, all files are synthesized."}),"\n",(0,s.jsx)(n.p,{children:"If this project has a parent, this directory is relative to the parent\ndirectory and it cannot be the same as the parent or any of it's other\nsubprojects."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"parentoptional--1",children:[(0,s.jsx)(n.code,{children:"parent"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"parent",id:"projen.github.GitHubProjectOptions.property.parent"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly parent: Project;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Project"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The parent project, if this project is part of a bigger project."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projecttreeoptional-",children:[(0,s.jsx)(n.code,{children:"projectTree"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"projectTree",id:"projen.github.GitHubProjectOptions.property.projectTree"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projectTree: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Generate a project tree file (",(0,s.jsx)(n.code,{children:".projen/tree.json"}),") that shows all components and their relationships. Useful for understanding your project structure and debugging."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projencommandoptional-",children:[(0,s.jsx)(n.code,{children:"projenCommand"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"projenCommand",id:"projen.github.GitHubProjectOptions.property.projenCommand"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projenCommand: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "npx projen"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The shell command to use in order to run the projen CLI."}),"\n",(0,s.jsx)(n.p,{children:"Inserted verbatim into task steps, workflows and IDE configuration, and run\nby each of their shells - locally, in CI and in dev containers. Keep it a\nplain unquoted command, since shell syntax in it executes in all of them."}),"\n",(0,s.jsx)(n.p,{children:"Can be used to customize in special environments."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projenrcjsonoptional-",children:[(0,s.jsx)(n.code,{children:"projenrcJson"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"projenrcJson",id:"projen.github.GitHubProjectOptions.property.projenrcJson"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projenrcJson: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Generate (once) .projenrc.json (in JSON). Set to ",(0,s.jsx)(n.code,{children:"false"})," in order to disable .projenrc.json generation."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projenrcjsonoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"projenrcJsonOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"projenrcJsonOptions",id:"projen.github.GitHubProjectOptions.property.projenrcJsonOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projenrcJsonOptions: ProjenrcJsonOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.ProjenrcJsonOptions"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default options"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options for .projenrc.json."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"renovatebotoptional-",children:[(0,s.jsx)(n.code,{children:"renovatebot"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"renovatebot",id:"projen.github.GitHubProjectOptions.property.renovatebot"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly renovatebot: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Use renovatebot to handle dependency upgrades."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"renovatebotoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"renovatebotOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"renovatebotOptions",id:"projen.github.GitHubProjectOptions.property.renovatebotOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly renovatebotOptions: RenovatebotOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.RenovatebotOptions"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default options"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options for renovatebot."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"autoapproveoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"autoApproveOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"autoApproveOptions",id:"projen.github.GitHubProjectOptions.property.autoApproveOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly autoApproveOptions: AutoApproveOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.AutoApproveOptions",children:"AutoApproveOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," auto approve is disabled"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Enable and configure the 'auto approve' workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"automergeoptional-",children:[(0,s.jsx)(n.code,{children:"autoMerge"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"autoMerge",id:"projen.github.GitHubProjectOptions.property.autoMerge"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly autoMerge: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Enable automatic merging on GitHub."}),"\n",(0,s.jsxs)(n.p,{children:["Has no effect if ",(0,s.jsx)(n.code,{children:"github.mergify"}),"\nis set to false."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"automergeoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"autoMergeOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"autoMergeOptions",id:"projen.github.GitHubProjectOptions.property.autoMergeOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly autoMergeOptions: AutoMergeOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.AutoMergeOptions",children:"AutoMergeOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," see defaults in ",(0,s.jsx)(n.code,{children:"AutoMergeOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Configure options for automatic merging on GitHub."}),"\n",(0,s.jsxs)(n.p,{children:["Has no effect if\n",(0,s.jsx)(n.code,{children:"github.mergify"})," or ",(0,s.jsx)(n.code,{children:"autoMerge"})," is set to false."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"clobberoptional-",children:[(0,s.jsx)(n.code,{children:"clobber"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"clobber",id:"projen.github.GitHubProjectOptions.property.clobber"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly clobber: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true, but false for subprojects"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Add a ",(0,s.jsx)(n.code,{children:"clobber"})," task which resets the repo to origin."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"devcontaineroptional--1",children:[(0,s.jsx)(n.code,{children:"devContainer"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"devContainer",id:"projen.github.GitHubProjectOptions.property.devContainer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly devContainer: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Add a VSCode development environment (used for GitHub Codespaces)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githuboptional--1",children:[(0,s.jsx)(n.code,{children:"github"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"github",id:"projen.github.GitHubProjectOptions.property.github"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly github: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Enable GitHub integration."}),"\n",(0,s.jsx)(n.p,{children:"Enabled by default for root projects. Disabled for non-root projects."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"githuboptionsoptional-",children:[(0,s.jsx)(n.code,{children:"githubOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"githubOptions",id:"projen.github.GitHubProjectOptions.property.githubOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly githubOptions: GitHubOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitHubOptions",children:"GitHubOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," see GitHubOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options for GitHub integration."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitpodoptional--1",children:[(0,s.jsx)(n.code,{children:"gitpod"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"gitpod",id:"projen.github.GitHubProjectOptions.property.gitpod"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitpod: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Add a Gitpod development environment."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"projencredentialsoptional--2",children:[(0,s.jsx)(n.code,{children:"projenCredentials"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"projenCredentials",id:"projen.github.GitHubProjectOptions.property.projenCredentials"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly projenCredentials: GithubCredentials;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," use a personal access token named PROJEN_GITHUB_TOKEN"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Choose a method of providing GitHub API access for projen workflows."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"readmeoptional-",children:[(0,s.jsx)(n.code,{children:"readme"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"readme",id:"projen.github.GitHubProjectOptions.property.readme"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly readme: SampleReadmeProps;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.SampleReadmeProps"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," { filename: 'README.md', contents: '# replace this' }"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The README setup."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.em,{children:"Example"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"\"{ filename: 'readme.md', contents: '# title' }\"\n"})}),"\n",(0,s.jsxs)(n.h5,{id:"staleoptional-",children:[(0,s.jsx)(n.code,{children:"stale"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"stale",id:"projen.github.GitHubProjectOptions.property.stale"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly stale: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,

1{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Auto-close of stale issues and pull request."}),"\n",(0,s.jsxs)(n.p,{children:["See ",(0,s.jsx)(n.code,{children:"staleOptions"})," for options."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"staleoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"staleOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"staleOptions",id:"projen.github.GitHubProjectOptions.property.staleOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly staleOptions: StaleOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.StaleOptions",children:"StaleOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," see defaults in ",(0,s.jsx)(n.code,{children:"StaleOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Auto-close stale issues and pull requests."}),"\n",(0,s.jsxs)(n.p,{children:["To disable set ",(0,s.jsx)(n.code,{children:"stale"})," to ",(0,s.jsx)(n.code,{children:"false"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"vscodeoptional--1",children:[(0,s.jsx)(n.code,{children:"vscode"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"vscode",id:"projen.github.GitHubProjectOptions.property.vscode"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly vscode: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Enable VSCode integration."}),"\n",(0,s.jsx)(n.p,{children:"Enabled by default for root projects. Disabled for non-root projects."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"githubworkflowoptions-",children:["GithubWorkflowOptions ",(0,s.jsx)(n.a,{name:"GithubWorkflowOptions",id:"projen.github.GithubWorkflowOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"GithubWorkflow"}),"."]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--22",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.GithubWorkflowOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst githubWorkflowOptions: github.GithubWorkflowOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--38",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflowOptions.property.concurrencyOptions",children:"concurrencyOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ConcurrencyOptions",children:"ConcurrencyOptions"})})}),(0,s.jsx)(n.td,{children:"Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflowOptions.property.env",children:"env"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: string}"})}),(0,s.jsx)(n.td,{children:"Additional environment variables to set for the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflowOptions.property.fileName",children:"fileName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Set a custom file name for the workflow definition file. Must include either a .yml or .yaml file extension."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflowOptions.property.force",children:"force"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsxs)(n.td,{children:["Force the creation of the workflow even if ",(0,s.jsx)(n.code,{children:"workflows"})," is disabled in ",(0,s.jsx)(n.code,{children:"GitHub"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubWorkflowOptions.property.limitConcurrency",children:"limitConcurrency"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Enable concurrency limitations."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"concurrencyoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"concurrencyOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"concurrencyOptions",id:"projen.github.GithubWorkflowOptions.property.concurrencyOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly concurrencyOptions: ConcurrencyOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.ConcurrencyOptions",children:"ConcurrencyOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," { group: ${{ github.workflow }}, cancelInProgress: false }"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time."}),"\n",(0,s.jsx)(n.p,{children:"Currently in beta."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#concurrency",children:"https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#concurrency"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"envoptional--5",children:[(0,s.jsx)(n.code,{children:"env"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"env",id:"projen.github.GithubWorkflowOptions.property.env"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly env: {[ key: string ]: string};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: string}"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no additional environment variables"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Additional environment variables to set for the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"filenameoptional-",children:[(0,s.jsx)(n.code,{children:"fileName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"fileName",id:"projen.github.GithubWorkflowOptions.property.fileName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly fileName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," a path-safe version of the workflow name plus the .yml file ending, e.g. build.yml"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Set a custom file name for the workflow definition file. Must include either a .yml or .yaml file extension."}),"\n",(0,s.jsx)(n.p,{children:"Use this option to set a file name for the workflow file, that is different than the display name."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.em,{children:"Example"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:'"my-workflow.yaml"\n'})}),"\n",(0,s.jsxs)(n.h5,{id:"forceoptional-",children:[(0,s.jsx)(n.code,{children:"force"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"force",id:"projen.github.GithubWorkflowOptions.property.force"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly force: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Force the creation of the workflow even if ",(0,s.jsx)(n.code,{children:"workflows"})," is disabled in ",(0,s.jsx)(n.code,{children:"GitHub"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"limitconcurrencyoptional-",children:[(0,s.jsx)(n.code,{children:"limitConcurrency"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"limitConcurrency",id:"projen.github.GithubWorkflowOptions.property.limitConcurrency"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly limitConcurrency: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Enable concurrency limitations."}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.code,{children:"concurrencyOptions"})," to configure specific non default values."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"gitidentity-",children:["GitIdentity ",(0,s.jsx)(n.a,{name:"GitIdentity",id:"projen.github.GitIdentity"})]}),"\n",(0,s.jsx)(n.p,{children:"Represents the git identity."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--23",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.GitIdentity.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst gitIdentity: github.GitIdentity = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--39",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity.property.email",children:"email"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The email address of the git user."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the user."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"emailrequired-",children:[(0,s.jsx)(n.code,{children:"email"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"email",id:"projen.github.GitIdentity.property.email"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly email: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The email address of the git user."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"namerequired--9",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.GitIdentity.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the user."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"mergequeueoptions-",children:["MergeQueueOptions ",(0,s.jsx)(n.a,{name:"MergeQueueOptions",id:"projen.github.MergeQueueOptions"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for 'MergeQueue'."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--24",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.MergeQueueOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst mergeQueueOptions: github.MergeQueueOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--40",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueueOptions.property.autoQueue",children:"autoQueue"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Should pull requests be queued automatically to be merged once they pass required checks."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueueOptions.property.autoQueueOptions",children:"autoQueueOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions",children:"AutoQueueOptions"})})}),(0,s.jsx)(n.td,{children:"Configure auto-queue pull requests."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeQueueOptions.property.targetBranches",children:"targetBranches"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"The branches that can be merged into using MergeQueue."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"autoqueueoptional-",children:[(0,s.jsx)(n.code,{children:"autoQueue"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"autoQueue",id:"projen.github.MergeQueueOptions.property.autoQueue"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly autoQueue: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Should pull requests be queued automatically to be merged once they pass required checks."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"autoqueueoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"autoQueueOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"autoQueueOptions",id:"projen.github.MergeQueueOptions.property.autoQueueOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly autoQueueOptions: AutoQueueOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.AutoQueueOptions",children:"AutoQueueOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," see AutoQueueOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Configure auto-queue pull requests."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"targetbranchesoptional--1",children:[(0,s.jsx)(

1n.code,{children:"targetBranches"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"targetBranches",id:"projen.github.MergeQueueOptions.property.targetBranches"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly targetBranches: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," all branches"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The branches that can be merged into using MergeQueue."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"mergifycommitmessageformat-",children:["MergifyCommitMessageFormat ",(0,s.jsx)(n.a,{name:"MergifyCommitMessageFormat",id:"projen.github.MergifyCommitMessageFormat"})]}),"\n",(0,s.jsxs)(n.p,{children:["Declarative configuration for Mergify ",(0,s.jsx)(n.code,{children:"commit_message_format"}),"."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.mergify.com/wor

1kflow/actions/merge/#customizing-the-commit-message",children:"https://docs.mergify.com/workflow/actions/merge/#customizing-the-commit-message"})}),"\n"]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--25",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.MergifyCommitMessageFormat.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst mergifyCommitMessageFormat: github.MergifyCommitMessageFormat = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--41",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyCommitMessageFormat.property.body",children:"body"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Commit body format."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyCommitMessageFormat.property.title",children:"title"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Commit title format."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyCommitMessageFormat.property.trailers",children:"trailers"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Optional list of trailers to append to the commit message."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"bodyoptional-",children:[(0,s.jsx)(n.code,{children:"body"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"body",id:"projen.github.MergifyCommitMessageFormat.property.body"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly body: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Commit body format."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"inherit"}),": use the GitHub repository default merge commit body format"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"pr-body"}),": use the pull request body"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"empty"}),": set the commit body to be empty"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"titleoptional-",children:[(0,s.jsx)(n.code,{children:"title"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"title",id:"projen.github.MergifyCommitMessageFormat.property.title"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly title: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Commit title format."}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"inherit"}),": use the GitHub repository default merge commit title format"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"pr-title"}),": use the pull request title (with the PR number appended)"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"trailersoptional-",children:[(0,s.jsx)(n.code,{children:"trailers"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"trailers",id:"projen.github.MergifyCommitMessageFormat.property.trailers"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly trailers: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Optional list of trailers to append to the commit message."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"mergifyconditionaloperator-",children:["MergifyConditionalOperator ",(0,s.jsx)(n.a,{name:"MergifyConditionalOperator",id:"projen.github.MergifyConditionalOperator"})]}),"\n",(0,s.jsxs)(n.p,{children:["The Mergify conditional operators that can be used are: ",(0,s.jsx)(n.code,{children:"or"})," and ",(0,s.jsx)(n.code,{children:"and"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"Note: The number of nested conditions is limited to 3."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.mergify.io/conditions/#combining-conditions-with-operators",children:"https://docs.mergify.io/conditions/#combining-conditions-with-operators"})}),"\n"]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--26",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.MergifyConditionalOperator.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst mergifyConditionalOperator: github.MergifyConditionalOperator = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--42",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator.property.and",children:"and"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["string | ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator",children:"MergifyConditionalOperator"}),"[]"]})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator.property.or",children:"or"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["string | ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator",children:"MergifyConditionalOperator"}),"[]"]})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"andoptional-",children:[(0,s.jsx)(n.code,{children:"and"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"and",id:"projen.github.MergifyConditionalOperator.property.and"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly and: (string | MergifyConditionalOperator)[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string | ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator",children:"MergifyConditionalOperator"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"oroptional-",children:[(0,s.jsx)(n.code,{children:"or"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"or",id:"projen.github.MergifyConditionalOperator.property.or"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly or: (string | MergifyConditionalOperator)[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string | ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator",children:"MergifyConditionalOperator"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"mergifyoptions-",children:["MergifyOptions ",(0,s.jsx)(n.a,{name:"MergifyOptions",id:"projen.github.MergifyOptions"})]}),"\n",(0,s.jsx)(n.p,{children:"Configure Mergify."}),"\n",(0,s.jsx)(n.p,{children:"This currently only offers a subset of options available."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.mergify.com/configuration/file-format/",children:"https://docs.mergify.com/configuration/file-format/"})}),"\n"]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--27",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.MergifyOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst mergifyOptions: github.MergifyOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--43",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyOptions.property.queues",children:"queues"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.MergifyQueue",children:"MergifyQueue"}),"[]"]})}),(0,s.jsx)(n.td,{children:"The available merge queues."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyOptions.property.rules",children:"rules"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.MergifyRule",children:"MergifyRule"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Pull request automation rules."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"queuesoptional-",children:[(0,s.jsx)(n.code,{children:"queues"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"queues",id:"projen.github.MergifyOptions.property.queues"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly queues: MergifyQueue[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyQueue",children:"MergifyQueue"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The available merge queues."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"rulesoptional-",children:[(0,s.jsx)(n.code,{children:"rules"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"rules",id:"projen.github.MergifyOptions.property.rules"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly rules: MergifyRule[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyRule",children:"MergifyRule"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Pull request automation rules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"mergifyqueue-",children:["MergifyQueue ",(0,s.jsx)(n.a,{name:"MergifyQueue",id:"projen.github.MergifyQueue"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--28",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.MergifyQueue.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst mergifyQueue: github.MergifyQueue = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--44",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyQueue.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the queue."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyQueue.property.commitMessageFormat",children:"commitMessageFormat"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyCommitMessageFormat",children:"MergifyCommitMessageFormat"})})}),(0,s.jsx)(n.td,{children:"When merging with the merge or squash method, configure the title, body, and trailers of the resulting commit."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyQueue.property.commitMessageTemplate",children:"commitMessageTemplate"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Template to use as the commit message when using the merge or squash merge method."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyQueue.property.mergeConditions",children:"mergeConditions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["string | ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator",children:"MergifyConditionalOperator"}),"[]"]})}),(0,s.jsx)(n.td,{children:"The list of conditions to match to get the queued pull request merged."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyQueue.property.mergeMethod",children:"mergeMethod"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Merge method to use."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyQueue.property.queueConditions",children:"queueConditions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["string | ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator",children:"MergifyConditionalOperator"}),"[]"]})}),(0,s.jsx)(n.td,{children:"The list of conditions that needs to match to queue the pull request."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyQueue.property.updateMethod",children:"updateMethod"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Method to use to update the pull request with its base branch when the speculative check is done in-place."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"namerequired--10",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.MergifyQueue.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the queue."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"commitmessageformatoptional-",children:[(0,s.jsx)(n.code,{children:"commitMessageFormat"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"commitMessageFormat",id:"projen.github.MergifyQueue.property.commitMessageFormat"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly commitMessageFormat: MergifyCommitMessageFormat;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n

1.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyCommitMessageFormat",children:"MergifyCommitMessageFormat"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"When merging with the merge or squash method, configure the title, body, and trailers of the resulting commit."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.mergify.com/workflow/actions/merge/#customizing-the-commit-message",children:"https://docs.mergify.com/workflow/actions/merge/#customizing-the-commit-message"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"commitmessagetemplateoptional-",children:[(0,s.jsx)(n.del,{children:(0,s.jsx)(n.code,{children:"commitMessageTemplate"})}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"commitMessageTemplate",id:"projen.github.MergifyQueue.property.commitMessageTemplate"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Deprecated:"})," Use ",(0,s.jsx)(n.code,{children:"commitMessageFormat"})," instead."]}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly commitMessageTemplate: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Template to use as the commit message when using the merge or squash merge method."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mergeconditionsoptional-",children:[(0,s.jsx)(n.code,{children:"mergeConditions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mergeConditions",id:"projen.github.MergifyQueue.property.mergeConditions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mergeConditions: (string | MergifyConditionalOperator)[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string | ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator",children:"MergifyConditionalOperator"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The list of conditions to match to get the queued pull request merged."}),"\n",(0,s.jsx)(n.p,{children:"This automatically includes the queueConditions.\nIn case of speculative merge pull request, the merge conditions are evaluated against the temporary pull request instead of the original one."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.mergify.com/conditions/#conditions",children:"https://docs.mergify.com/conditions/#conditions"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mergemethodoptional--1",children:[(0,s.jsx)(n.code,{children:"mergeMethod"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mergeMethod",id:"projen.github.MergifyQueue.property.mergeMethod"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mergeMethod: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "merge"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Merge method to use."}),"\n",(0,s.jsxs)(n.p,{children:["Possible values are ",(0,s.jsx)(n.code,{children:"merge"}),", ",(0,s.jsx)(n.code,{children:"squash"}),", ",(0,s.jsx)(n.code,{children:"rebase"})," or ",(0,s.jsx)(n.code,{children:"fast-forward"}),".\n",(0,s.jsx)(n.code,{children:"fast-forward"})," is not supported on queues with ",(0,s.jsx)(n.code,{children:"speculative_checks"})," > 1, ",(0,s.jsx)(n.code,{children:"batch_size"})," > 1, or with ",(0,s.jsx)(n.code,{children:"allow_inplace_checks"})," set to false."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"queueconditionsoptional-",children:[(0,s.jsx)(n.code,{children:"queueConditions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"queueConditions",id:"projen.github.MergifyQueue.property.queueConditions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly queueConditions: (string | MergifyConditionalOperator)[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string | ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator",children:"MergifyConditionalOperator"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The list of conditions that needs to match to queue the pull request."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.mergify.com/conditions/#conditions",children:"https://docs.mergify.com/conditions/#conditions"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"updatemethodoptional-",children:[(0,s.jsx)(n.code,{children:"updateMethod"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"updateMethod",id:"projen.github.MergifyQueue.property.updateMethod"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly updateMethod: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," ",(0,s.jsx)(n.code,{children:"merge"})," for all merge methods except ",(0,s.jsx)(n.code,{children:"fast-forward"})," where ",(0,s.jsx)(n.code,{children:"rebase"})," is used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Method to use to update the pull request with its base branch when the speculative check is done in-place."}),"\n",(0,s.jsx)(n.p,{children:"Possible values:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"merge"})," to merge the base branch into the pull request."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"rebase"})," to rebase the pull request against its base branch."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Note that the ",(0,s.jsx)(n.code,{children:"rebase"})," method has some drawbacks, see Mergify docs for details."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.mergify.com/actions/queue/#queue-rules",children:"https://docs.mergify.com/actions/queue/#queue-rules"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"mergifyrule-",children:["MergifyRule ",(0,s.jsx)(n.a,{name:"MergifyRule",id:"projen.github.MergifyRule"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--29",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.MergifyRule.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github }

1 from 'projen'\n\nconst mergifyRule: github.MergifyRule = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--45",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyRule.property.actions",children:"actions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: any}"})}),(0,s.jsx)(n.td,{children:"A dictionary made of Actions that will be executed on the matching pull requests."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyRule.property.conditions",children:"conditions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["string | ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator",children:"MergifyConditionalOperator"}),"[]"]})}),(0,s.jsx)(n.td,{children:"A list of Conditions string that must match against the pull request for the rule to be applied."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergifyRule.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the rule."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actionsrequired--1",children:[(0,s.jsx)(n.code,{children:"actions"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"actions",id:"projen.github.MergifyRule.property.actions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly actions: {[ key: string ]: any};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: any}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A dictionary made of Actions that will be executed on the matching pull requests."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.mergify.io/actions/#actions",children:"https://docs.mergify.io/actions/#actions"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"conditionsrequired--1",children:[(0,s.jsx)(n.code,{children:"conditions"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"conditions",id:"projen.github.MergifyRule.property.conditions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly conditions: (string | MergifyConditionalOperator)[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string | ",(0,s.jsx)(n.a,{href:"#projen.github.MergifyConditionalOperator",children:"MergifyConditionalOperator"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A list of Conditions string that must match against the pull request for the rule to be applied."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.mergify.io/conditions/#conditions",children:"https://docs.mergify.io/conditions/#conditions"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"namerequired--11",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.MergifyRule.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the rule."}),"\n",(0,s.jsx)(n.p,{children:"This is not used by the engine directly,\nbut is used when reporting information about a rule."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"pullrequestbackportoptions-",children:["PullRequestBackportOptions ",(0,s.jsx)(n.a,{name:"PullRequestBackportOptions",id:"projen.github.PullRequestBackportOptions"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--30",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.PullRequestBackportOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst pullRequestBackportOptions: github.PullRequestBackportOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--46",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions.property.runsOn",children:"runsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Github Runner selection labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions.property.runsOnGroup",children:"runsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:"Github Runner Group selection options."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions.property.autoApproveBackport",children:"autoApproveBackport"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Automatically approve backport PRs if the 'auto approve' workflow is available."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions.property.backp

1ortBranchNamePrefix",children:"backportBranchNamePrefix"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The prefix used to name backport branches."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions.property.backportPRLabels",children:"backportPRLabels"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"The labels added to the created backport PR."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions.property.branches",children:"branches"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"List of branches that can be a target for backports."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions.property.createWithConflicts",children:"createWithConflicts"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Should this created Backport PRs with conflicts."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions.property.labelPrefix",children:"labelPrefix"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The prefix used to detect PRs that should be backported."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestBackportOptions.property.workflowName",children:"workflowName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the workflow."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonoptional--4",children:[(0,s.jsx)(n.code,{children:"runsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOn",id:"projen.github.PullRequestBackportOptions.property.runsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["ubuntu-latest"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner selection labels."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsongroupoptional--4",children:[(0,s.jsx)(n.code,{children:"runsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOnGroup",id:"projen.github.PullRequestBackportOptions.property.runsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner Group selection options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"autoapprovebackportoptional-",children:[(0,s.jsx)(n.code,{children:"autoApproveBackport"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"autoApproveBackport",id:"projen.github.PullRequestBackportOptions.property.autoApproveBackport"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly autoApproveBackport: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Automatically approve backport PRs if the 'auto approve' workflow is available."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"backportbranchnameprefixoptional-",children:[(0,s.jsx)(n.code,{children:"backportBranchNamePrefix"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"backportBranchNamePrefix",id:"projen.github.PullRequestBackportOptions.property.backp

1ortBranchNamePrefix"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly backportBranchNamePrefix: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "backport/"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The prefix used to name backport branches."}),"\n",(0,s.jsxs)(n.p,{children:["Make sure to include a separator at the end like ",(0,s.jsx)(n.code,{children:"/"})," or ",(0,s.jsx)(n.code,{children:"_"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"backportprlabelsoptional-",children:[(0,s.jsx)(n.code,{children:"backportPRLabels"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"backportPRLabels",id:"projen.github.PullRequestBackportOptions.property.backportPRLabels"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly backportPRLabels: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["backport"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The labels added to the created backport PR."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"branchesoptional-",children:[(0,s.jsx)(n.code,{children:"branches"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"branches",id:"projen.github.PullRequestBackportOptions.property.branches"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly branches: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," allow backports to all release branches"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"List of branches that can be a target for backports."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"createwithconflictsoptional-",children:[(0,s.jsx)(n.code,{children:"createWithConflicts"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"createWithConflicts",id:"projen.github.PullRequestBackportOptions.property.createWithConflicts"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly createWithConflicts: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Should this created Backport PRs with conflicts."}),"\n",(0,s.jsxs)(n.p,{children:["Conflicts will have to be resolved manually, but a PR is always created.\nSet to ",(0,s.jsx)(n.code,{children:"false"})," to prevent the backport PR from being created if there are conflicts."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"labelprefixoptional-",children:[(0,s.jsx)(n.code,{children:"labelPrefix"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"labelPrefix",id:"projen.github.PullRequestBackportOptions.property.labelPrefix"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly labelPrefix: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "backport-to-"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The prefix used to detect PRs that should be backported."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workflownameoptional-",children:[(0,s.jsx)(n.code,{children:"workflowName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"workflowName",id:"projen.github.PullRequestBackportOptions.property.workflowName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workflowName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "backport"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"pullrequestfrompatchoptions-",children:["PullRequestFromPatchOptions ",(0,s.jsx)(n.a,{name:"PullRequestFromPatchOptions",id:"projen.github.PullRequestFromPatchOptions"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--31",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.PullRequestFromPatchOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst pullRequestFromPatchOptions: github.PullRequestFromPatchOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--47",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.pullRequestDescription",children:"pullRequestDescription"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Description added to the pull request."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.pullRequestTitle",children:"pullRequestTitle"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The full title used to create the pull request."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.workflowName",children:"workflowName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the workflow that will create the PR."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.addPaths",children:"addPaths"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsxs)(n.td,{children:["Paths to add to the commit, mapping to the action's ",(0,s.jsx)(n.code,{children:"add-paths"})," input."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.assignees",children:"assignees"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Assignees to add on the PR."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.baseBranch",children:"baseBranch"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Sets the pull request base branch."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.branchName",children:"branchName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The pull request branch name."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.credentials",children:"credentials"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})})}),(0,s.jsx)(n.td,{children:"The job credentials used to create the pull request."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.deleteBranch",children:"deleteBranch"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsxs)(n.td,{children:["Whether to delete the pull request branch when the pull request is closed, mapping to the action's ",(0,s.jsx)(n.code,{children:"delete-branch"})," input."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.gitIdentity",children:"gitIdentity"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity",children:"GitIdentity"})})}),(0,s.jsx)(n.td,{children:"The git identity used to create the commit."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.labels",children:"labels"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Labels to apply on the PR."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.signoff",children:"signoff"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}

1),(0,s.jsx)(n.td,{children:"Add Signed-off-by line by the committer at the end of the commit log message."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.stepId",children:"stepId"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The step ID which produces the output which indicates if a patch was created."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.stepName",children:"stepName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the step displayed on GitHub."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.patch",children:"patch"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource",children:"PullRequestPatchSource"})})}),(0,s.jsx)(n.td,{children:"Information about the patch that is used to create the pull request."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.jobName",children:"jobName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the job displayed on GitHub."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.runsOn",children:"runsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Github Runner selection labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions.property.runsOnGroup",children:"runsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:"Github Runner Group selection options."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pullrequestdescriptionrequired--1",children:[(0,s.jsx)(n.code,{children:"pullRequestDescription"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"pullRequestDescription",id:"projen.github.PullRequestFromPatchOptions.property.pullRequestDescription"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly pullRequestDescription: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Description added to the pull request."}),"\n",(0,s.jsx)(n.p,{children:"Providence information are automatically added."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pullrequesttitlerequired--1",children:[(0,s.jsx)(n.code,{children:"pullRequestTitle"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"pullRequestTitle",id:"projen.github.PullRequestFromPatchOptions.property.pullRequestTitle"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly pullRequestTitle: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The full title used to create the pull request."}),"\n",(0,s.jsx)(n.p,{children:"If PR titles are validated in this repo, the title should comply with the respective rules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workflownamerequired--1",children:[(0,s.jsx)(n.code,{children:"workflowName"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"workflowName",id:"projen.github.PullRequestFromPatchOptions.property.workflowName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workflowName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the workflow that will create the PR."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"addpathsoptional--1",children:[(0,s.jsx)(n.code,{children:"addPaths"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"addPaths",id:"projen.github.PullRequestFromPatchOptions.property.addPaths"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly addPaths: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," all paths"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Paths to add to the commit, mapping to the action's ",(0,s.jsx)(n.code,{children:"add-paths"})," input."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"assigneesoptional--2",children:[(0,s.jsx)(n.code,{children:"assignees"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"assignees",id:"projen.github.PullRequestFromPatchOptions.property.assignees"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly assignees: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no assignees"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Assignees to add on the PR."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"basebranchoptional--1",children:[(0,s.jsx)(n.code,{children:"baseBranch"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"baseBranch",id:"projen.github.PullRequestFromPatchOptions.property.baseBranch"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly baseBranch: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," The branch checked out in the workflow."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets the pull request base branch."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"branchnameoptional--1",children:[(0,s.jsx)(n.code,{children:"branchName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"branchName",id:"projen.github.PullRequestFromPatchOptions.property.branchName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly branchName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," ",(0,s.jsx)(n.code,{children:"github-actions/${options.workflowName}"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The pull request branch name."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"credentialsoptional--1",children:[(0,s.jsx)(n.code,{children:"credentials"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"credentials",id:"projen.github.PullRequestFromPatchOptions.property.credentials"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly credentials: GithubCredentials;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials",children:"GithubCredentials"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The job credentials used to create the pull request."}),"\n",(0,s.jsx)(n.p,{children:"Provided credentials must have permissions to create a pull request on the repository."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"deletebranchoptional--1",children:[(0,s.jsx)(n.code,{children:"deleteBranch"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"deleteBranch",id:"projen.github.PullRequestFromPatchOptions.property.deleteBranch"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly deleteBranch: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Whether to delete the pull request branch when the pull request is closed, mapping to the action's ",(0,s.jsx)(n.code,{children:"delete-branch"})," input."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitidentityoptional--1",children:[(0,s.jsx)(n.code,{children:"gitIdentity"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"gitIdentity",id:"projen.github.PullRequestFromPatchOptions.property.gitIdentity"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitIdentity: GitIdentity;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity",children:"GitIdentity"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default GitHub Actions user"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The git identity used to create the commit."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"labelsoptional--3",children:[(0,s.jsx)(n.code,{children:"labels"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"labels",id:"projen.github.PullRequestFromPatchOptions.property.labels"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly labels: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no labels."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Labels to apply on the PR."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"signoffoptional--1",children:[(0,s.jsx)(n.code,{children:"signoff"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"signoff",id:"projen.github.PullRequestFromPatchOptions.property.signoff"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly signoff: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}

1),"\n",(0,s.jsx)(n.p,{children:"Add Signed-off-by line by the committer at the end of the commit log message."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"stepidoptional--1",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.PullRequestFromPatchOptions.property.stepId"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly stepId: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "create_pr"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step ID which produces the output which indicates if a patch was created."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"stepnameoptional--1",children:[(0,s.jsx)(n.code,{children:"stepName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"stepName",id:"projen.github.PullRequestFromPatchOptions.property.stepName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly stepName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "Create Pull Request"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the step displayed on GitHub."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"patchrequired--2",children:[(0,s.jsx)(n.code,{children:"patch"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"patch",id:"projen.github.PullRequestFromPatchOptions.property.patch"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly patch: PullRequestPatchSource;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource",children:"PullRequestPatchSource"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Information about the patch that is used to create the pull request."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"jobnameoptional-",children:[(0,s.jsx)(n.code,{children:"jobName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"jobName",id:"projen.github.PullRequestFromPatchOptions.property.jobName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly jobName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "Create Pull Request"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the job displayed on GitHub."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonoptional--5",children:[(0,s.jsx)(n.code,{children:"runsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOn",id:"projen.github.PullRequestFromPatchOptions.property.runsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["ubuntu-latest"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner selection labels."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsongroupoptional--5",children:[(0,s.jsx)(n.code,{children:"runsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOnGroup",id:"projen.github.PullRequestFromPatchOptions.property.runsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner Group selection options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"pullrequestlintoptions-",children:["PullRequestLintOptions ",(0,s.jsx)(n.a,{name:"PullRequestLintOptions",id:"projen.github.PullRequestLintOptions"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for PullRequestLint."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--32",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.PullRequestLintOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst pullRequestLintOptions: github.PullRequestLintOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--48",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLintOptions.property.runsOn",children:"runsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Github Runner selection labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLintOptions.property.runsOnGroup",children:"runsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:"Github Runner Group selection options."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLintOptions.property.contributorStatement",children:"contributorStatement"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Require a contributor statement to be included in the PR de

1scription."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLintOptions.property.contributorStatementOptions",children:"contributorStatementOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ContributorStatementOptions",children:"ContributorStatementOptions"})})}),(0,s.jsx)(n.td,{children:"Options for requiring a contributor statement on Pull Requests."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLintOptions.property.semanticTitle",children:"semanticTitle"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Validate that pull request titles follow Conventional Commits."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestLintOptions.property.semanticTitleOptions",children:"semanticTitleOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SemanticTitleOptions",children:"SemanticTitleOptions"})})}),(0,s.jsx)(n.td,{children:"Options for validating the conventional commit title linter."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonoptional--6",children:[(0,s.jsx)(n.code,{children:"runsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOn",id:"projen.github.PullRequestLintOptions.property.runsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["ubuntu-latest"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner selection labels."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsongroupoptional--6",children:[(0,s.jsx)(n.code,{children:"runsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOnGroup",id:"projen.github.PullRequestLintOptions.property.runsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner Group selection options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"contributorstatementoptional-",children:[(0,s.jsx)(n.code,{children:"contributorStatement"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"contributorStatement",id:"projen.github.PullRequestLintOptions.property.contributorStatement"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly contributorStatement: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no contributor statement is required"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Require a contributor statement to be included in the PR description."}),"\n",(0,s.jsx)(n.p,{children:"For example confirming that the contribution has been made by the contributor and complies with the project's license."}),"\n",(0,s.jsx)(n.p,{children:"Appends the statement to the end of the Pull Request template."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"contributorstatementoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"contributorStatementOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"contributorStatementOptions",id:"projen.github.PullRequestLintOptions.property.contributorStatementOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly contributorStatementOptions: ContributorStatementOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.ContributorStatementOptions",children:"ContributorStatementOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," none"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options for requiring a contributor statement on Pull Requests."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"semantictitleoptional-",children:[(0,s.jsx)(n.code,{children:"semanticTitle"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"semanticTitle",id:"projen.github.PullRequestLintOptions.property.semanticTitle"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly semanticTitle: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Validate that pull request titles follow Conventional Commits."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://www.conventionalcommits.org/",children:"https://www.conventionalcommits.org/"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"semantictitleoptionsoptional-",children:[(0,s.jsx)(n.code,{children:"semanticTitleOptions"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"semanticTitleOptions",id:"projen.github.PullRequestLintOptions.property.semanticTitleOptions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly semanticTitleOptions: SemanticTitleOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.SemanticTitleOptions",children:"SemanticTitleOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' title must start with "feat", "fix", or "chore"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options for validating the conventional commit title linter."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"pullrequestpatchsource-",children:["PullRequestPatchSource ",(0,s.jsx)(n.a,{name:"PullRequestPatchSource",id:"projen.github.PullRequestPatchSource"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--33",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.PullRequestPatchSource.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst pullRequestPatchSource: github.PullRequestPatchSource = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--49",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource.property.fetchDepth",children:"fetchDepth"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Number of commits to fetch."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource.property.lfs",children:"lfs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether LFS is enabled for the GitHub repository."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource.property.path",children:"path"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Relative path under $GITHUB_WORKSPACE to place the repository."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource.property.ref",children:"ref"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Branch or tag name."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource.property.repository",children:"repository"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The repository (owner/repo) to use."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource.property.submodules",children:"submodules"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})})}),(0,s.jsx)(n.td,{children:"Whether to checkout Git submodules."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource.property.token",children:"token"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A GitHub token to use when checking out the repository."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource.property.patchFile",children:"patchFile"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the artifact the patch is stored as."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource.property.jobId",children:"jobId"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The id of the job that created the patch f

1ile."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestPatchSource.property.outputName",children:"outputName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the output that indicates if a patch has been created."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"fetchdepthoptional--2",children:[(0,s.jsx)(n.code,{children:"fetchDepth"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"fetchDepth",id:"projen.github.PullRequestPatchSource.property.fetchDepth"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly fetchDepth: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," 1"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Number of commits to fetch."}),"\n",(0,s.jsx)(n.p,{children:"0 indicates all history for all branches and tags."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"lfsoptional--2",children:[(0,s.jsx)(n.code,{children:"lfs"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"lfs",id:"projen.github.PullRequestPatchSource.property.lfs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly lfs: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether LFS is enabled for the GitHub repository."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pathoptional--3",children:[(0,s.jsx)(n.code,{children:"path"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"path",id:"projen.github.PullRequestPatchSource.property.path"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly path: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," $GITHUB_WORKSPACE"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Relative path under $GITHUB_WORKSPACE to place the repository."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"refoptional--2",children:[(0,s.jsx)(n.code,{children:"ref"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"ref",id:"projen.github.PullRequestPatchSource.property.ref"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ref: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," the default branch is implicitly used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Branch or tag name."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"repositoryoptional--3",children:[(0,s.jsx)(n.code,{children:"repository"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"repository",id:"projen.github.PullRequestPatchSource.property.repository"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly repository: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," the default repository is implicitly used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The repository (owner/repo) to use."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"submodulesoptional--2",children:[(0,s.jsx)(n.code,{children:"submodules"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"submodules",id:"projen.github.PullRequestPatchSource.property.submodules"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly submodules: CheckoutSubmodules;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," CheckoutSubmodules.DISABLED"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to checkout Git submodules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tokenoptional--4",children:[(0,s.jsx)(n.code,{children:"token"}),(0,s.jsx)(n.sup,{children:"Optional"}

1)," ",(0,s.jsx)(n.a,{name:"token",id:"projen.github.PullRequestPatchSource.property.token"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly token: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," the default GITHUB_TOKEN is implicitly used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A GitHub token to use when checking out the repository."}),"\n",(0,s.jsxs)(n.p,{children:["If the intent is to push changes back to the branch, then you must use a\nPAT with ",(0,s.jsx)(n.code,{children:"repo"})," (and possibly ",(0,s.jsx)(n.code,{children:"workflows"}),") permissions."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"patchfileoptional--1",children:[(0,s.jsx)(n.code,{children:"patchFile"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"patchFile",id:"projen.github.PullRequestPatchSource.property.patchFile"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly patchFile: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ".repo.patch"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the artifact the patch is stored as."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"jobidrequired--15",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.PullRequestPatchSource.property.jobId"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly jobId: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The id of the job that created the patch file."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"outputnamerequired-",children:[(0,s.jsx)(n.code,{children:"outputName"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"outputName",id:"projen.github.PullRequestPatchSource.property.outputName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly outputName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the output that indicates if a patch has been created."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"pullrequesttemplateoptions-",children:["PullRequestTemplateOptions ",(0,s.jsx)(n.a,{name:"PullRequestTemplateOptions",id:"projen.github.PullRequestTemplateOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"PullRequestTemplate"}),"."]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--34",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.PullRequestTemplateOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst pullRequestTemplateOptions: github.PullRequestTemplateOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--50",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.PullRequestTemplateOptions.property.lines",children:"lines"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"The contents of the template."})]})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"linesoptional-",children:[(0,s.jsx)(n.code,{children:"lines"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"lines",id:"projen.github.PullRequestTemplateOptions.property.lines"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly lines: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," a standard default template will be created."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The contents of the template."}),"\n",(0,s.jsxs)(n.p,{children:["You can use ",(0,s.jsx)(n.code,{children:"addLine()"})," to add additional lines."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"semantictitleoptions-",children:["SemanticTitleOptions ",(0,s.jsx)(n.a,{name:"SemanticTitleOptions",id:"projen.github.SemanticTitleOptions"})]}),"\n",(0,s.jsx)(n.p,{children:"Options for linting that PR titles follow Conventional Commits."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://www.conventionalcommits.org/",children:"https://www.conventionalcommits.org/"})}),"\n"]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--35",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.SemanticTitleOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst semanticTitleOptions: github.SemanticTitleOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--51",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SemanticTitleOptions.property.requireScope",children:"requireScope"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Configure that a scope must always be provided."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SemanticTitleOptions.property.scopes",children:"scopes"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Configure which scopes are allowed (newline-delimited)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SemanticTitleOptions.property.types",children:"types"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Configure a list of commit types that are allowed."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"requirescopeoptional-",children:[(0,s.jsx)(n.code,{children:"requireScope"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"requireScope",id:"projen.github.SemanticTitleOptions.property.requireScope"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly requireScope: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Configure that a scope must always be provided."}),"\n",(0,s.jsx)(n.p,{children:"e.g. feat(ui), fix(core)"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"scopesoptional-",children:[(0,s.jsx)(n.code,{children:"scopes"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"scopes",id:"projen.github.SemanticTitleOptions.property.scopes"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly scopes: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," all scopes allowed"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Configure which scopes are allowed (newline-delimited)."}),"\n",(0,s.jsxs)(n.p,{children:["These are regex patterns auto-wrapped in ",(0,s.jsx)(n.code,{children:"^ $"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"typesoptional-",children:[(0,s.jsx)(n.code,{children:"types"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"types",id:"projen.github.SemanticTitleOptions.property.types"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly types: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["feat", "fix", "chore"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Configure a list of commit types that are allowed."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"setupgitidentityoptions-",children:["SetupGitIdentityOptions ",(0,s.jsx)(n.a,{name:"SetupGitIdentityOptions",id:"projen.github.SetupGitIdentityOptions"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--36",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.SetupGitIdentityOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst setupGitIdentityOptions: github.SetupGitIdentityOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--52",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.env",children:"env"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: string}"})}),(0,s.jsx)(n.td,{children:"Sets environment variables for steps to use in the runner environment."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.id",children:"id"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A unique identifier for the step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.if",children:"if"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"You can use the if conditional to prevent a job from running unless a condition is met."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A name for your step to display on GitHub."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.shell",children:"shell"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Overrides the default shell settings in the runner's operating system and the job's default."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.workingDirectory",children:"workingDirectory"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Specifies a working directory for a step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.background",children:"background"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Runs a step asynchronously so the job c

1ontinues to the next step without waiting for it to finish."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.cancel",children:"cancel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["Gracefully terminates a running background step, referenced by its ",(0,s.jsx)(n.code,{children:"id"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.continueOnError",children:"continueOnError"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Prevents a job from failing when a step fails."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.parallel",children:"parallel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Runs a group of steps concurrently, then waits for all of them to finish before continuing."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.timeoutMinutes",children:"timeoutMinutes"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"The maximum number of minutes to run the step before killing the process."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.wait",children:"wait"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsxs)(n.td,{children:["Pauses the job until one or more background steps complete. Provide the ",(0,s.jsx)(n.code,{children:"id"}),"s of the background steps to wait for."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.waitAll",children:"waitAll"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Pauses the job until all active background steps complete."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions.property.gitIdentity",children:"gitIdentity"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity",children:"GitIdentity"})})}),(0,s.jsx)(n.td,{children:"The identity to use."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"envoptional--6",children:[(0,s.jsx)(n.code,{children:"env"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"env",id:"projen.github.SetupGitIdentityOptions.property.env"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly env: {[ key: string ]: string};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: string}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets environment variables for steps to use in the runner environment."}),"\n",(0,s.jsx)(n.p,{children:"You can also set environment variables for the entire workflow or a job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"idoptional--2",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.SetupGitIdentityOptions.property.id"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly id: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A unique identifier for the step."}),"\n",(0,s.jsx)(n.p,{children:"You can use the id to reference the\nstep in contexts."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"ifoptional--3",children:[(0,s.jsx)(n.code,{children:"if"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"if",id:"projen.github.SetupGitIdentityOptions.property.if"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly if: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"You can use the if conditional to prevent a job from running unless a condition is met."}

1),"\n",(0,s.jsx)(n.p,{children:"You can use any supported context and expression to\ncreate a conditional."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"nameoptional--4",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.SetupGitIdentityOptions.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A name for your step to display on GitHub."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"shelloptional--2",children:[(0,s.jsx)(n.code,{children:"shell"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"shell",id:"projen.github.SetupGitIdentityOptions.property.shell"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly shell: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Overrides the default shell settings in the runner's operating system and the job's default."}),"\n",(0,s.jsx)(n.p,{children:"Refer to GitHub documentation for allowed values."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workingdirectoryoptional--2",children:[(0,s.jsx)(n.code,{children:"workingDirectory"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"workingDirectory",id:"projen.github.SetupGitIdentityOptions.property.workingDirectory"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workingDirectory: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies a working directory for a step."}),"\n",(0,s.jsx)(n.p,{children:"Overrides a job's working directory."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"backgroundoptional--2",children:[(0,s.jsx)(n.code,{children:"background"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"background",id:"projen.github.SetupGitIdentityOptions.property.background"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly background: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Runs a step asynchronously so the job continues to the next step without waiting for it to finish."}),"\n",(0,s.jsx)(n.p,{children:"Use for long-running processes, such as\ndatabases, servers, or monitoring tasks, that need to run alongside other\nsteps."}),"\n",(0,s.jsxs)(n.p,{children:["Synchronize with background steps later using ",(0,s.jsx)(n.code,{children:"wait"})," or ",(0,s.jsx)(n.code,{children:"waitAll"}),", or\nstop them with ",(0,s.jsx)(n.code,{children:"cancel"}),". Give the step an ",(0,s.jsx)(n.code,{children:"id"})," so it can be referenced."]}),"\n",(0,s.jsx)(n.p,{children:"A maximum of 10 background steps can run concurrently in a single job;\nadditional background steps are queued until a slot is free."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsbackground",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsbackground"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"canceloptional--2",children:[(0,s.jsx)(n.code,{children:"cancel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"cancel",id:"projen.github.SetupGitIdentityOptions.property.cancel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly cancel: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Gracefully terminates a running background step, referenced by its ",(0,s.jsx)(n.code,{children:"id"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"The runner sends the step's process a termination signal (SIGTERM) so it\ncan clean up, and forcibly stops it (SIGKILL) if it does not exit within\na short grace peri

1od."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepscancel",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepscancel"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"continueonerroroptional--3",children:[(0,s.jsx)(n.code,{children:"continueOnError"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"continueOnError",id:"projen.github.SetupGitIdentityOptions.property.continueOnError"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly continueOnError: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Prevents a job from failing when a step fails."}),"\n",(0,s.jsx)(n.p,{children:"Set to true to allow a job\nto pass when this step fails."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"paralleloptional--2",children:[(0,s.jsx)(n.code,{children:"parallel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"parallel",id:"projen.github.SetupGitIdentityOptions.property.parallel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly parallel: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Runs a group of steps concurrently, then waits for all of them to finish before continuing."}),"\n",(0,s.jsxs)(n.p,{children:["This is shorthand for declaring each step with\n",(0,s.jsx)(n.code,{children:"background: true"})," followed by a ",(0,s.jsx)(n.code,{children:"wait"})," step."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this when you have a self-contained group of independent steps that\ncan all run at the same time and don't need to be referenced\nindividually. Use ",(0,s.jsx)(n.code,{children:"background"})," instead when you need finer control, such\nas starting a long-running process that stays up while later steps run."]}),"\n",(0,s.jsx)(n.p,{children:"Each step in the group is subject to the same 10-step concurrency limit\nas other background steps. Cannot be used inside a composite action."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsparallel",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsparallel"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"timeoutminutesoptional--3",children:[(0,s.jsx)(n.code,{children:"timeoutMinutes"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"timeoutMinutes",id:"projen.github.SetupGitIdentityOptions.property.timeoutMinutes"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly timeoutMinutes: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The maximum number of minutes to run the step before killing the process."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"waitoptional--2",children:[(0,s.jsx)(n.code,{children:"wait"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"wait",id:"projen.github.SetupGitIdentityOptions.property.wait"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly wait: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Pauses the job until one or more background steps complete. Provide the ",(0,s.jsx)(n.code,{children:"id"}),"s of the background steps to wait for."]}),"\n",(0,s.jsxs)(n.p,{children:["This step performs no work itself; it only blocks until the referenced\nbackground steps finish. If a referenced background step failed, the\n",(0,s.jsx)(n.code,{children:"wait"})," step fails too."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"waitalloptional--2",children:[(0,s.jsx)(n.code,{children:"waitAll"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"waitAll",id:"projen.github.SetupGitIdentityOptions.property.waitAll"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly waitAll: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Pauses the job until all active background steps complete."}),"\n",(0,s.jsxs)(n.p,{children:["Fails if any\nof the background steps it waits on failed, unless ",(0,s.jsx)(n.code,{children:"continueOnError"})," is\nset on this step."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait-all",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait-all"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitidentityrequired-",children:[(0,s.jsx)(n.code,{children:"gitIdentity"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"gitIdentity",id:"projen.github.SetupGitIdentityOptions.property.gitIdentity"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitIdentity: GitIdentity;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity",children:"GitIdentity"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The identity to use."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"stalebehavior-",children:["StaleBehavior ",(0,s.jsx)(n.a,{name:"StaleBehavior",id:"projen.github.StaleBehavior"})]}),"\n",(0,s.jsx)(n.p,{children:"Stale behavior."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--37",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.StaleBehavior.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github }

1 from 'projen'\n\nconst staleBehavior: github.StaleBehavior = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--53",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior.property.closeMessage",children:"closeMessage"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The comment to add to the issue/PR when it's closed."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior.property.daysBeforeClose",children:"daysBeforeClose"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:'Days until the issue/PR is closed after it is marked as "Stale".'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior.property.daysBeforeStale",children:"daysBeforeStale"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:'How many days until the issue or pull request is marked as "Stale".'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior.property.enabled",children:"enabled"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Determines if this behavior is enabled."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior.property.exemptLabels",children:"exemptLabels"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Label which exempt an issue/PR from becoming stale."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior.property.staleLabel",children:"staleLabel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The label to apply to the issue/PR when it becomes stale."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior.property.staleMessage",children:"staleMessage"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The comment to add to the issue/PR when it becomes stale."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"closemessageoptional-",children:[(0,s.jsx)(n.code,{children:"closeMessage"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"closeMessage",id:"projen.github.StaleBehavior.property.closeMessage"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly closeMessage: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," \"Closing this pull request as it hasn't seen activity for a while. Please add a comment"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The comment to add to the issue/PR when it's closed."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"daysbeforecloseoptional-",children:[(0,s.jsx)(n.code,{children:"daysBeforeClose"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"daysBeforeClose",id:"projen.github.StaleBehavior.property.daysBeforeClose"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly daysBeforeClose: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.em,{children:"Default:"})}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Days until the issue/PR is closed after it is marked as "Stale".'}),"\n",(0,s.jsx)(n.p,{children:"Set to -1 to disable."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"daysbeforestaleoptional-",children:[(0,s.jsx)(n.code,{children:"daysBeforeStale"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"daysBeforeStale",id:"projen.github.StaleBehavior.property.daysBeforeStale"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly daysBeforeStale: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.em,{children:"Default:"})}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'How many days until the issue or pull request is marked as "Stale".'}),"\n",(0,s.jsx)(n.p,{children:"Set to -1 to disable."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"enabledoptional-",children:[(0,s.jsx)(n.code,{children:"enabled"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"enabled",id:"projen.github.StaleBehavior.property.enabled"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly enabled: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Determines if this behavior is enabled."}),"\n",(0,s.jsxs)(n.p,{children:["Same as setting ",(0,s.jsx)(n.code,{children:"daysBeforeStale"})," and ",(0,s.jsx)(n.code,{children:"daysBeforeClose"})," to ",(0,s.jsx)(n.code,{children:"-1"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"exemptlabelsoptional--1",children:[(0,s.jsx)(n.code,{children:"exemptLabels"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"exemptLabels",id:"projen.github.StaleBehavior.property.exemptLabels"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly exemptLabels: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["backlog"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Label which exempt an issue/PR from becoming stale."}),"\n",(0,s.jsxs)(n.p,{children:["Set to ",(0,s.jsx)(n.code,{children:"[]"})," to disable."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"stalelabeloptional-",children:[(0,s.jsx)(n.code,{children:"staleLabel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"staleLabel",id:"projen.github.StaleBehavior.property.staleLabel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly staleLabel: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "stale"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The label to apply to the issue/PR when it becomes stale."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"stalemessageoptional-",children:[(0,s.jsx)(n.code,{children:"staleMessage"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"staleMessage",id:"projen.github.StaleBehavior.property.staleMessage"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly staleMessage: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "This pull request is now marked as stale because hasn\'t seen activity for a 

1while. Add a comment or it will be closed soon."']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The comment to add to the issue/PR when it becomes stale."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"staleoptions-",children:["StaleOptions ",(0,s.jsx)(n.a,{name:"StaleOptions",id:"projen.github.StaleOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"Stale"}),"."]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--38",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.StaleOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst staleOptions: github.StaleOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--54",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleOptions.property.runsOn",children:"runsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Github Runner selection labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleOptions.property.runsOnGroup",children:"runsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:"Github Runner Group selection options."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleOptions.property.issues",children:"issues"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior",children:"StaleBehavior"})})}),(0,s.jsx)(n.td,{children:"How to handle stale issues."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleOptions.property.pullRequest",children:"pullRequest"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior",children:"StaleBehavior"})})}),(0,s.jsx)(n.td,{children:"How to handle stale pull requests."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonoptional--7",children:[(0,s.jsx)(n.code,{children:"runsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOn",id:"projen.github.StaleOptions.property.runsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["ubuntu-latest"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner selection labels."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsongroupoptional--7",children:[(0,s.jsx)(n.code,{children:"runsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOnGroup",id:"projen.github.StaleOptions.property.runsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner Group selection options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"issuesoptional-",children:[(0,s.jsx)(n.code,{children:"issues"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"issues",id:"projen.github.StaleOptions.property.issues"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly issues: StaleBehavior;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior",children:"StaleBehavior"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," By default, stale issues with no activity will be marked as stale after 60 days and closed within 7 days."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"How to handle stale issues."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pullrequestoptional-",children:[(0,s.jsx)(n.code,{children:"pullRequest"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"pullRequest",id:"projen.github.StaleOptions.property.pullRequest"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly pullRequest: StaleBehavior;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.StaleBehavior",children:"StaleBehavior"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," By default, pull requests with no activity will be marked as stale after 14 days and closed within 2 days with relevant comments."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"How to handle stale pull requests."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"taskworkflowjoboptions-",children:["TaskWorkflowJobOptions ",(0,s.jsx)(n.a,{name:"TaskWorkflowJobOptions",id:"projen.github.TaskWorkflowJobOptions"})]}),"\n",(0,s.jsx)(n.p,{children:"Options to create the Job associated with a TaskWorkflow."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--39",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.TaskWorkflowJobOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst taskWorkflowJobOptions: github.TaskWorkflowJobOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--55",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.permissions",children:"permissions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobPermissions",children:"JobPermissions"})})}),(0,s.jsx)(n.td,{children:"Permissions for the build job."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.artifactsDirectory",children:"artifactsDirectory"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["A directory name which contains artifacts to be uploaded (e.g. ",(0,s.jsx)(n.code,{children:"dist"}),"). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.checkoutSubmodules",children:"checkoutSubmodules"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})})}),(0,s.jsx)(n.td,{children:"Whether to checkout Git submodules."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.checkoutWith",children:"checkoutWith"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith",children:"CheckoutWith"})})}),(0,s.jsxs)(n.td,{children:["Override for the ",(0,s.jsx)(n.code,{children:"with"}

1)," property of the source code checkout step."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.condition",children:"condition"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Adds an 'if' condition to the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.container",children:"container"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.ContainerOptions",children:"ContainerOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.downloadLfs",children:"downloadLfs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether to download files from Git LFS for this workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.env",children:"env"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: string}"})}),(0,s.jsx)(n.td,{children:"Workflow environment variables."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.environment",children:"environment"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The GitHub Actions environment used for the job."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.gitIdentity",children:"gitIdentity"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity",children:"GitIdentity"})})}),(0,s.jsx)(n.td,{children:"The git identity to use in this workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.jobDefaults",children:"jobDefaults"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobDefaults",children:"JobDefaults"})})}),(0,s.jsx)(n.td,{children:"Default settings for all steps in the TaskWorkflow Job."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.outputs",children:"outputs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["{[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStepOutput",children:"JobStepOutput"}),"}"]})}),(0,s.jsx)(n.td,{children:"Mapping of job output names to values/expressions."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.postBuildSteps",children:"postBuildSteps"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Actions to run after the main build step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.preBuildSteps",children:"preBuildSteps"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Steps to run before the main build step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.preCheckoutSteps",children:"preCheckoutSteps"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Initial steps to run before the source code 

1checkout."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.runsOn",children:"runsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Github Runner selection labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowJobOptions.property.runsOnGroup",children:"runsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:"Github Runner Group selection options."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"permissionsrequired--1",children:[(0,s.jsx)(n.code,{children:"permissions"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"permissions",id:"projen.github.TaskWorkflowJobOptions.property.permissions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly permissions: JobPermissions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobPermissions",children:"JobPermissions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Permissions for the build job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"artifactsdirectoryoptional--1",children:[(0,s.jsx)(n.code,{children:"artifactsDirectory"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"artifactsDirectory",id:"projen.github.TaskWorkflowJobOptions.property.artifactsDirectory"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly artifactsDirectory: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," not set"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A directory name which contains artifacts to be uploaded (e.g. ",(0,s.jsx)(n.code,{children:"dist"}),"). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"checkoutsubmodulesoptional--1",children:[(0,s.jsx)(n.code,{children:"checkoutSubmodules"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"checkoutSubmodules",id:"projen.github.TaskWorkflowJobOptions.property.checkoutSubmodules"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly checkoutSubmodules: CheckoutSubmodules;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," Use the setting on the corresponding GitHub project"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to checkout Git submodules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"checkoutwithoptional-",children:[(0,s.jsx)(n.code,{children:"checkoutWith"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"checkoutWith",id:"projen.github.TaskWorkflowJobOptions.property.checkoutWith"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly checkoutWith: CheckoutWith;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith",children:"CheckoutWith"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," not set"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Override for the ",(0,s.jsx)(n.code,{children:"with"})," property of the source code checkout step."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"conditionoptional-",children:[(0,s.jsx)(n.code,{children:"condition"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"condition",id:"projen.github.TaskWorkflowJobOptions.property.condition"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly condition: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Adds an 'if' condition to the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"containeroptional--1",children:[(0,s.jsx)(n.code,{children:"container"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"container",id:"projen.github.TaskWorkflowJobOptions.property.container"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly container: ContainerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.ContainerOptions",children:"ContainerOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default image"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"downloadlfsoptional--1",children:[(0,s.jsx)(n.code,{children:"downloadLfs"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"downloadLfs",id:"projen.github.TaskWorkflowJobOptions.property.downloadLfs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly downloadLfs: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," Use the setting on the corresponding GitHub project"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to download files from Git LFS for this workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"envoptional--7",children:[(0,s.jsx)(n.code,{children:"env"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"env",id:"projen.github.TaskWorkflowJobOptions.property.env"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly env: {[ key: string ]: string};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: string}"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," {}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Workflow environment variables."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"environmentoptional--3",children:[(0,s.jsx)(n.code,{children:"environment"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"environment",id:"projen.github.TaskWorkflowJobOptions.property.environment"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly environment: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no environment used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The GitHub Actions environment used for the job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitidentityoptional--2",children:[(0,s.jsx)(n.code,{children:"gitIdentity"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"gitIdentity",id:"projen.github.TaskWorkflowJobOptions.property.gitIdentity"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitIdentity: GitIdentity;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity",children:"GitIdentity"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default GitHub Actions user"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The git identity to use in this workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"jobdefaultsoptional-",children:[(0,s.jsx)(n.code,{children:"jobDefaults"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"jobDefaults",id:"projen.github.TaskWorkflowJobOptions.property.jobDefaults"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly jobDefaults: JobDefaults;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobDefaults",children:"JobDefaults"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default settings for all steps in the TaskWorkflow Job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"outputsoptional--1",children:[(0,s.jsx)(n.code,{children:"outputs"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"outputs",id:"projen.github.TaskWorkflowJobOptions.property.outputs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly outputs: {[ key: string ]: JobStepOutput};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStepOutput",children:"JobStepOutput"}),"}"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," {}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Mapping of job output names to values/expressions."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postbuildstepsoptional-",children:[(0,s.jsx)(n.code,{children:"postBuildSteps"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"postBuildSteps",id:"projen.github.TaskWorkflowJobOptions.property.postBuildSteps"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly postBuildSteps: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," not set"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Actions to run after the main build step."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"prebuildstepsoptional-",children:[(0,s.jsx)(n.code,{children:"preBuildSteps"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"preBuildSteps",id:"projen.github.TaskWorkflowJobOptions.property.preBuildSteps"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly preBuildSteps: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," not set"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Steps to run before the main build step."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"precheckoutstepsoptional-",children:[(0,s.jsx)(n.code,{children:"preCheckoutSteps"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"preCheckoutSteps",id:"projen.github.TaskWorkflowJobOptions.property.preCheckoutSteps"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly preCheckoutSteps: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," not set"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Initial steps to run before the source code 

1checkout."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonoptional--8",children:[(0,s.jsx)(n.code,{children:"runsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOn",id:"projen.github.TaskWorkflowJobOptions.property.runsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["ubuntu-latest"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner selection labels."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsongroupoptional--8",children:[(0,s.jsx)(n.code,{children:"runsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOnGroup",id:"projen.github.TaskWorkflowJobOptions.property.runsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner Group selection options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"taskworkflowoptions-",children:["TaskWorkflowOptions ",(0,s.jsx)(n.a,{name:"TaskWorkflowOptions",id:"projen.github.TaskWorkflowOptions"})]}),"\n",(0,s.jsx)(n.p,{children:"Options to create a TaskWorkflow."}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--40",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.TaskWorkflowOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst taskWorkflowOptions: github.TaskWorkflowOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--56",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.permissions",children:"permissions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobPermissions",children:"JobPermissions"})})}),(0,s.jsx)(n.td,{children:"Permissions for the build job."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.artifactsDirectory",children:"artifactsDirectory"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["A directory name which contains artifacts to be uploaded (e.g. ",(0,s.jsx)(n.code,{children:"dist"}),"). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.checkoutSubmodules",children:"checkoutSubmodules"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})})}),(0,s.jsx)(n.td,{children:"Whether to checkout Git submodules."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.checkoutWith",children:"checkoutWith"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith",children:"CheckoutWith"})})}),(0,s.jsxs)(n.td,{children:["Override for the ",(0,s.jsx)(n.code,{children:"with"}

1)," property of the source code checkout step."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.condition",children:"condition"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Adds an 'if' condition to the workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.container",children:"container"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.ContainerOptions",children:"ContainerOptions"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.downloadLfs",children:"downloadLfs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether to download files from Git LFS for this workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.env",children:"env"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: string}"})}),(0,s.jsx)(n.td,{children:"Workflow environment variables."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.environment",children:"environment"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The GitHub Actions environment used for the job."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.gitIdentity",children:"gitIdentity"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity",children:"GitIdentity"})})}),(0,s.jsx)(n.td,{children:"The git identity to use in this workflow."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.jobDefaults",children:"jobDefaults"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobDefaults",children:"JobDefaults"})})}),(0,s.jsx)(n.td,{children:"Default settings for all steps in the TaskWorkflow Job."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.outputs",children:"outputs"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:["{[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStepOutput",children:"JobStepOutput"}),"}"]})}),(0,s.jsx)(n.td,{children:"Mapping of job output names to values/expressions."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.postBuildSteps",children:"postBuildSteps"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Actions to run after the main build step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.preBuildSteps",children:"preBuildSteps"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Steps to run before the main build step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.preCheckoutSteps",children:"preCheckoutSteps"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Initial steps to run before the source code 

1checkout."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.runsOn",children:"runsOn"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsx)(n.td,{children:"Github Runner selection labels."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.runsOnGroup",children:"runsOnGroup"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.GroupRunnerOptions"})}),(0,s.jsx)(n.td,{children:"Github Runner Group selection options."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The workflow name."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.task",children:"task"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"projen.Task"})}),(0,s.jsx)(n.td,{children:"The main task to be executed."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.jobId",children:"jobId"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The primary job id."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.TaskWorkflowOptions.property.triggers",children:"triggers"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.workflows.Triggers",children:"Triggers"})})}),(0,s.jsx)(n.td,{children:"The triggers for the workflow."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"permissionsrequired--2",children:[(0,s.jsx)(n.code,{children:"permissions"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"permissions",id:"projen.github.TaskWorkflowOptions.property.permissions"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly permissions: JobPermissions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobPermissions",children:"JobPermissions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Permissions for the build job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"artifactsdirectoryoptional--2",children:[(0,s.jsx)(n.code,{children:"artifactsDirectory"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"artifactsDirectory",id:"projen.github.TaskWorkflowOptions.property.artifactsDirectory"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly artifactsDirectory: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," not set"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["A directory name which contains artifacts to be uploaded (e.g. ",(0,s.jsx)(n.code,{children:"dist"}),"). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"checkoutsubmodulesoptional--2",children:[(0,s.jsx)(n.code,{children:"checkoutSubmodules"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"checkoutSubmodules",id:"projen.github.TaskWorkflowOptions.property.checkoutSubmodules"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly checkoutSubmodules: CheckoutSubmodules;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules",children:"CheckoutSubmodules"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," Use the setting on the corresponding GitHub project"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to checkout Git submodules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"checkoutwithoptional--1",children:[(0,s.jsx)(n.code,{children:"checkoutWith"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"checkoutWith",id:"projen.github.TaskWorkflowOptions.property.checkoutWith"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly checkoutWith: CheckoutWith;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWith",children:"CheckoutWith"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," not set"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Override for the ",(0,s.jsx)(n.code,{children:"with"}

1)," property of the source code checkout step."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"conditionoptional--1",children:[(0,s.jsx)(n.code,{children:"condition"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"condition",id:"projen.github.TaskWorkflowOptions.property.condition"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly condition: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Adds an 'if' condition to the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"containeroptional--2",children:[(0,s.jsx)(n.code,{children:"container"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"container",id:"projen.github.TaskWorkflowOptions.property.container"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly container: ContainerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.ContainerOptions",children:"ContainerOptions"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default image"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"downloadlfsoptional--2",children:[(0,s.jsx)(n.code,{children:"downloadLfs"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"downloadLfs",id:"projen.github.TaskWorkflowOptions.property.downloadLfs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly downloadLfs: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," Use the setting on the corresponding GitHub project"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to download files from Git LFS for this workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"envoptional--8",children:[(0,s.jsx)(n.code,{children:"env"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"env",id:"projen.github.TaskWorkflowOptions.property.env"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly env: {[ key: string ]: string};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: string}"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," {}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Workflow environment variables."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"environmentoptional--4",children:[(0,s.jsx)(n.code,{children:"environment"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"environment",id:"projen.github.TaskWorkflowOptions.property.environment"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly environment: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," no environment used"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The GitHub Actions environment used for the job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"gitidentityoptional--3",children:[(0,s.jsx)(n.code,{children:"gitIdentity"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"gitIdentity",id:"projen.github.TaskWorkflowOptions.property.gitIdentity"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly gitIdentity: GitIdentity;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GitIdentity",children:"GitIdentity"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," default GitHub Actions user"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The git identity to use in this workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"jobdefaultsoptional--1",children:[(0,s.jsx)(n.code,{children:"jobDefaults"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"jobDefaults",id:"projen.github.TaskWorkflowOptions.property.jobDefaults"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly jobDefaults: JobDefaults;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobDefaults",children:"JobDefaults"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Default settings for all steps in the TaskWorkflow Job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"outputsoptional--2",children:[(0,s.jsx)(n.code,{children:"outputs"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"outputs",id:"projen.github.TaskWorkflowOptions.property.outputs"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly outputs: {[ key: string ]: JobStepOutput};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStepOutput",children:"JobStepOutput"}),"}"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," {}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Mapping of job output names to values/expressions."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"postbuildstepsoptional--1",children:[(0,s.jsx)(n.code,{children:"postBuildSteps"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"postBuildSteps",id:"projen.github.TaskWorkflowOptions.property.postBuildSteps"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly postBuildSteps: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," not set"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Actions to run after the main build step."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"prebuildstepsoptional--1",children:[(0,s.jsx)(n.code,{children:"preBuildSteps"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"preBuildSteps",id:"projen.github.TaskWorkflowOptions.property.preBuildSteps"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly preBuildSteps: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," not set"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Steps to run before the main build step."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"precheckoutstepsoptional--1",children:[(0,s.jsx)(n.code,{children:"preCheckoutSteps"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"preCheckoutSteps",id:"projen.github.TaskWorkflowOptions.property.preCheckoutSteps"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly preCheckoutSteps: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," not set"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Initial steps to run before the source code 

1checkout."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsonoptional--9",children:[(0,s.jsx)(n.code,{children:"runsOn"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOn",id:"projen.github.TaskWorkflowOptions.property.runsOn"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOn: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ["ubuntu-latest"]']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner selection labels."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"runsongroupoptional--9",children:[(0,s.jsx)(n.code,{children:"runsOnGroup"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"runsOnGroup",id:"projen.github.TaskWorkflowOptions.property.runsOnGroup"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly runsOnGroup: GroupRunnerOptions;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.GroupRunnerOptions"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Github Runner Group selection options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"namerequired--12",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.TaskWorkflowOptions.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The workflow name."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"taskrequired--2",children:[(0,s.jsx)(n.code,{children:"task"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"task",id:"projen.github.TaskWorkflowOptions.property.task"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly task: Task;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," projen.Task"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The main task to be executed."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"jobidoptional-",children:[(0,s.jsx)(n.code,{children:"jobId"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"jobId",id:"projen.github.TaskWorkflowOptions.property.jobId"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly jobId: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "build"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The primary job id."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"triggersoptional-",children:[(0,s.jsx)(n.code,{children:"triggers"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"triggers",id:"projen.github.TaskWorkflowOptions.property.triggers"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly triggers: Triggers;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.Triggers",children:"Triggers"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," by default workflows can only be triggered by manually."]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The triggers for the workflow."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"uploadartifactoptions-",children:["UploadArtifactOptions ",(0,s.jsx)(n.a,{name:"UploadArtifactOptions",id:"projen.github.UploadArtifactOptions"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--41",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.UploadArtifactOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst uploadArtifactOptions: github.UploadArtifactOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--57",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.env",children:"env"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"{[ key: string ]: string}"})}),(0,s.jsx)(n.td,{children:"Sets environment variables for steps to use in the runner environment."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.id",children:"id"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A unique identifier for the step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.if",children:"if"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"You can use the if conditional to prevent a job from running unless a condition is met."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A name for your step to display on GitHub."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.shell",children:"shell"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Overrides the default shell settings in the runner's operating system and the job's default."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.workingDirectory",children:"workingDirectory"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Specifies a working directory for a step."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.background",children:"background"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Runs a step asynchronously so the job c

1ontinues to the next step without waiting for it to finish."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.cancel",children:"cancel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsxs)(n.td,{children:["Gracefully terminates a running background step, referenced by its ",(0,s.jsx)(n.code,{children:"id"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.continueOnError",children:"continueOnError"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Prevents a job from failing when a step fails."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.parallel",children:"parallel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Runs a group of steps concurrently, then waits for all of them to finish before continuing."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.timeoutMinutes",children:"timeoutMinutes"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"The maximum number of minutes to run the step before killing the process."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.wait",children:"wait"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string[]"})}),(0,s.jsxs)(n.td,{children:["Pauses the job until one or more background steps complete. Provide the ",(0,s.jsx)(n.code,{children:"id"}),"s of the background steps to wait for."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.waitAll",children:"waitAll"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Pauses the job until all active background steps complete."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions.property.with",children:"with"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactWith",children:"UploadArtifactWith"})})}),(0,s.jsxs)(n.td,{children:["Options for ",(0,s.jsx)(n.code,{children:"upload-artifact"}),"."]})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"envoptional--9",children:[(0,s.jsx)(n.code,{children:"env"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"env",id:"projen.github.UploadArtifactOptions.property.env"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly env: {[ key: string ]: string};\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," {[ key: string ]: string}"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets environment variables for steps to use in the runner environment."}),"\n",(0,s.jsx)(n.p,{children:"You can also set environment variables for the entire workflow or a job."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"idoptional--3",children:[(0,s.jsx)(n.code,{children:"id"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"id",id:"projen.github.UploadArtifactOptions.property.id"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly id: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A unique identifier for the step."}),"\n",(0,s.jsx)(n.p,{children:"You can use the id to reference the\nstep in contexts."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"ifoptional--4",children:[(0,s.jsx)(n.code,{children:"if"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"if",id:"projen.github.UploadArtifactOptions.property.if"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly if: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"You can use the if conditional to prevent a job from running unless a condition is met."}

1),"\n",(0,s.jsx)(n.p,{children:"You can use any supported context and expression to\ncreate a conditional."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"nameoptional--5",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.UploadArtifactOptions.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A name for your step to display on GitHub."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"shelloptional--3",children:[(0,s.jsx)(n.code,{children:"shell"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"shell",id:"projen.github.UploadArtifactOptions.property.shell"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly shell: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Overrides the default shell settings in the runner's operating system and the job's default."}),"\n",(0,s.jsx)(n.p,{children:"Refer to GitHub documentation for allowed values."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"workingdirectoryoptional--3",children:[(0,s.jsx)(n.code,{children:"workingDirectory"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"workingDirectory",id:"projen.github.UploadArtifactOptions.property.workingDirectory"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly workingDirectory: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Specifies a working directory for a step."}),"\n",(0,s.jsx)(n.p,{children:"Overrides a job's working directory."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"backgroundoptional--3",children:[(0,s.jsx)(n.code,{children:"background"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"background",id:"projen.github.UploadArtifactOptions.property.background"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly background: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Runs a step asynchronously so the job continues to the next step without waiting for it to finish."}),"\n",(0,s.jsx)(n.p,{children:"Use for long-running processes, such as\ndatabases, servers, or monitoring tasks, that need to run alongside other\nsteps."}),"\n",(0,s.jsxs)(n.p,{children:["Synchronize with background steps later using ",(0,s.jsx)(n.code,{children:"wait"})," or ",(0,s.jsx)(n.code,{children:"waitAll"}),", or\nstop them with ",(0,s.jsx)(n.code,{children:"cancel"}),". Give the step an ",(0,s.jsx)(n.code,{children:"id"})," so it can be referenced."]}),"\n",(0,s.jsx)(n.p,{children:"A maximum of 10 background steps can run concurrently in a single job;\nadditional background steps are queued until a slot is free."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsbackground",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsbackground"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"canceloptional--3",children:[(0,s.jsx)(n.code,{children:"cancel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"cancel",id:"projen.github.UploadArtifactOptions.property.cancel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly cancel: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Gracefully terminates a running background step, referenced by its ",(0,s.jsx)(n.code,{children:"id"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"The runner sends the step's process a termination signal (SIGTERM) so it\ncan clean up, and forcibly stops it (SIGKILL) if it does not exit within\na short grace peri

1od."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepscancel",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepscancel"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"continueonerroroptional--4",children:[(0,s.jsx)(n.code,{children:"continueOnError"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"continueOnError",id:"projen.github.UploadArtifactOptions.property.continueOnError"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly continueOnError: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Prevents a job from failing when a step fails."}),"\n",(0,s.jsx)(n.p,{children:"Set to true to allow a job\nto pass when this step fails."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"paralleloptional--3",children:[(0,s.jsx)(n.code,{children:"parallel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"parallel",id:"projen.github.UploadArtifactOptions.property.parallel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly parallel: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Runs a group of steps concurrently, then waits for all of them to finish before continuing."}),"\n",(0,s.jsxs)(n.p,{children:["This is shorthand for declaring each step with\n",(0,s.jsx)(n.code,{children:"background: true"})," followed by a ",(0,s.jsx)(n.code,{children:"wait"})," step."]}),"\n",(0,s.jsxs)(n.p,{children:["Use this when you have a self-contained group of independent steps that\ncan all run at the same time and don't need to be referenced\nindividually. Use ",(0,s.jsx)(n.code,{children:"background"})," instead when you need finer control, such\nas starting a long-running process that stays up while later steps run."]}),"\n",(0,s.jsx)(n.p,{children:"Each step in the group is subject to the same 10-step concurrency limit\nas other background steps. Cannot be used inside a composite action."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsparallel",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsparallel"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"timeoutminutesoptional--4",children:[(0,s.jsx)(n.code,{children:"timeoutMinutes"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"timeoutMinutes",id:"projen.github.UploadArtifactOptions.property.timeoutMinutes"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly timeoutMinutes: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The maximum number of minutes to run the step before killing the process."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"waitoptional--3",children:[(0,s.jsx)(n.code,{children:"wait"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"wait",id:"projen.github.UploadArtifactOptions.property.wait"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly wait: string[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Pauses the job until one or more background steps complete. Provide the ",(0,s.jsx)(n.code,{children:"id"}),"s of the background steps to wait for."]}),"\n",(0,s.jsxs)(n.p,{children:["This step performs no work itself; it only blocks until the referenced\nbackground steps finish. If a referenced background step failed, the\n",(0,s.jsx)(n.code,{children:"wait"})," step fails too."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"waitalloptional--3",children:[(0,s.jsx)(n.code,{children:"waitAll"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"waitAll",id:"projen.github.UploadArtifactOptions.property.waitAll"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly waitAll: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Pauses the job until all active background steps complete."}),"\n",(0,s.jsxs)(n.p,{children:["Fails if any\nof the background steps it waits on failed, unless ",(0,s.jsx)(n.code,{children:"continueOnError"})," is\nset on this step."]}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait-all",children:"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswait-all"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"withrequired--1",children:[(0,s.jsx)(n.code,{children:"with"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"with",id:"projen.github.UploadArtifactOptions.property.with"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly with: UploadArtifactWith;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactWith",children:"UploadArtifactWith"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"upload-artifact"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"uploadartifactwith-",children:["UploadArtifactWith ",(0,s.jsx)(n.a,{name:"UploadArtifactWith",id:"projen.github.UploadArtifactWith"})]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--42",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.UploadArtifactWith.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst uploadArtifactWith: github.UploadArtifactWith = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--58",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactWith.property.path",children:"path"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"A file, directory or wildcard pattern that describes what to upload."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactWith.property.compressionLevel",children:"compressionLevel"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"The level of compression for Zlib to be applied to the artifact archive."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactWith.property.ifNoFilesFound",children:"ifNoFilesFound"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The desired behavior if no files are found using the provided path."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactWith.property.includeHiddenFiles",children:"includeHiddenFiles"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether to include hidden files in the provided path in the artifact."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactWith.property.name",children:"name"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Name of the artifact to upload."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactWith.property.overwrite",children:"overwrite"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"boolean"})}),(0,s.jsx)(n.td,{children:"Whether action should overwrite an existing artifact with the same name (should one exist)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactWith.property.retentionDays",children:"retentionDays"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"number"})}),(0,s.jsx)(n.td,{children:"Duration after which artifact will expire in days. 0 means using default repository retention."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pathrequired--1",children:[(0,s.jsx)(n.code,{children:"path"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"path",id:"projen.github.UploadArtifactWith.property.path"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly path: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A file, directory or wildcard pattern that describes what to upload."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"compressionleveloptional-",children:[(0,s.jsx)(n.code,{children:"compressionLevel"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"compressionLevel",id:"projen.github.UploadArtifactWith.property.compressionLevel"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly compressionLevel: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," 6"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The level of compression for Zlib to be applied to the artifact archive."}),"\n",(0,s.jsx)(n.p,{children:"The value can range from 0 to 9.\nFor large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"ifnofilesfoundoptional-",children:[(0,s.jsx)(n.code,{children:"ifNoFilesFound"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"ifNoFilesFound",id:"projen.github.UploadArtifactWith.property.ifNoFilesFound"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ifNoFilesFound: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "warn"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The desired behavior if no files are found using the provided path."}),"\n",(0,s.jsx)(n.p,{children:"Available Options:\nwarn: Output a warning but do not fail the action\nerror: Fail the action with an error message\nignore: Do not output any warnings or errors, the action does not fail"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"includehiddenfilesoptional-",children:[(0,s.jsx)(n.code,{children:"includeHiddenFiles"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"includeHiddenFiles",id:"projen.github.UploadArtifactWith.property.includeHiddenFiles"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly includeHiddenFiles: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," false"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether to include hidden files in the provided path in the artifact."}),"\n",(0,s.jsx)(n.p,{children:"The file contents of any hidden files in the path should be validated before enabled this to avoid uploading sensitive information."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"nameoptional--6",children:[(0,s.jsx)(n.code,{children:"name"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"name",id:"projen.github.UploadArtifactWith.property.name"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly name: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "artifact"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Name of the artifact to upload."}),"\n",(0,s.jsx)(n.hr,{}

1),"\n",(0,s.jsxs)(n.h5,{id:"overwriteoptional-",children:[(0,s.jsx)(n.code,{children:"overwrite"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"overwrite",id:"projen.github.UploadArtifactWith.property.overwrite"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly overwrite: boolean;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," boolean"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," true"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether action should overwrite an existing artifact with the same name (should one exist)."}),"\n",(0,s.jsxs)(n.p,{children:["Introduced in v4 and represents a breaking change from the behavior of the v3 action.\nTo maintain backwards compatibility with existing, this should be set the ",(0,s.jsx)(n.code,{children:"true"})," (the default)."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"retentiondaysoptional-",children:[(0,s.jsx)(n.code,{children:"retentionDays"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"retentionDays",id:"projen.github.UploadArtifactWith.property.retentionDays"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly retentionDays: number;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," number"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," The default repository retention"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Duration after which artifact will expire in days. 0 means using default repository retention."}),"\n",(0,s.jsx)(n.p,{children:"Minimum 1 day.\nMaximum 90 days unless changed from the repository settings page."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"uploadgitpatchoptions-",children:["UploadGitPatchOptions ",(0,s.jsx)(n.a,{name:"UploadGitPatchOptions",id:"projen.github.UploadGitPatchOptions"})]}),"\n",(0,s.jsxs)(n.p,{children:["Options for ",(0,s.jsx)(n.code,{children:"uploadGitPatch"}),"."]}),"\n",(0,s.jsxs)(n.h4,{id:"initializer--43",children:["Initializer ",(0,s.jsx)(n.a,{name:"Initializer",id:"projen.github.UploadGitPatchOptions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nconst uploadGitPatchOptions: github.UploadGitPatchOptions = { ... }\n"})}),"\n",(0,s.jsxs)(n.h4,{id:"properties--59",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadGitPatchOptions.property.outputName",children:"outputName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the output to emit."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadGitPatchOptions.property.stepId",children:"stepId"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The step ID which produces the output which indicates if a patch was created."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadGitPatchOptions.property.mutationError",children:"mutationError"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"Fail if a mutation was found and print this error message."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadGitPatchOptions.property.patchFile",children:"patchFile"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the artifact the patch is stored as."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.UploadGitPatchOptions.property.stepName",children:"stepName"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The name of the step."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"outputnamerequired--1",children:[(0,s.jsx)(n.code,{children:"outputName"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"outputName",id:"projen.github.UploadGitPatchOptions.property.outputName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly outputN

1ame: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the output to emit."}),"\n",(0,s.jsxs)(n.p,{children:["It will be set to ",(0,s.jsx)(n.code,{children:"true"})," if there was a diff."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"stepidrequired--8",children:[(0,s.jsx)(n.code,{children:"stepId"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"stepId",id:"projen.github.UploadGitPatchOptions.property.stepId"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly stepId: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The step ID which produces the output which indicates if a patch was created."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"mutationerroroptional-",children:[(0,s.jsx)(n.code,{children:"mutationError"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"mutationError",id:"projen.github.UploadGitPatchOptions.property.mutationError"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly mutationError: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"})," do not fail upon mutation"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fail if a mutation was found and print this error message."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"patchfileoptional--2",children:[(0,s.jsx)(n.code,{children:"patchFile"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"patchFile",id:"projen.github.UploadGitPatchOptions.property.patchFile"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly patchFile: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' ".repo.patch"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the artifact the patch is stored as."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"stepnameoptional--2",children:[(0,s.jsx)(n.code,{children:"stepName"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"stepName",id:"projen.github.UploadGitPatchOptions.property.stepName"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly stepName: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Default:"}),' "Find mutations"']}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The name of the step."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h2,{id:"classes-",children:["Classes ",(0,s.jsx)(n.a,{name:"Classes",id:"Classes"})]}),"\n",(0,s.jsxs)(n.h3,{id:"actionrefs-",children:["ActionRefs ",(0,s.jsx)(n.a,{name:"ActionRefs",id:"projen.github.ActionRefs"})]}),"\n",(0,s.jsxs)(n.p,{children:["Fully qualified references (",(0,s.jsx)(n.code,{children:"owner/repo@ref"}),") for GitHub Actions."]}),"\n",(0,s.jsx)(n.p,{children:"Use these when authoring workflow steps, so that every step references a\nreviewed action version."}),"\n",(0,s.jsxs)(n.h4,{id:"constants--1",children:["Constants ",(0,s.jsx)(n.a,{name:"Constants",id:"Constants"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_CHECKOUT",children:"ACTIONS_CHECKOUT"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/checkout at v7.0.1."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_CREATE_GITHUB_APP_TOKEN",children:"ACTIONS_CREATE_GITHUB_APP_TOKEN"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/create-github-app-token at v3.2.0 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_DEPENDENCY_REVIEW_ACTION",children:"ACTIONS_DEPENDENCY_REVIEW_ACTION"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/dependency-review-action at v5.0.0."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_DOWNLOAD_ARTIFACT",children:"ACTIONS_DOWNLOAD_ARTIFACT"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/download-artifact at v8.0.1."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_GITHUB_SCRIPT",children:"ACTIONS_GITHUB_SCRIPT"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/github-script at v9.0.0."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_SETUP_DOTNET",children:"ACTIONS_SETUP_DOTNET"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/setup-dotnet at v6.0.0 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_SETUP_GO",children:"ACTIONS_SETUP_GO"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/setup-go at v7.0.0 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_SETUP_JAVA",children:"ACTIONS_SETUP_JAVA"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/setup-java at v6.0.0 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_SETUP_NODE",children:"ACTIONS_SETUP_NODE"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/setup-node at v7.0.0 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_SETUP_PYTHON",children:"ACTIONS_SETUP_PYTHON"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/setup-python at v7.0.0 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_STALE",children:"ACTIONS_STALE"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/stale at v11.0.0 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.ACTIONS_UPLOAD_ARTIFACT",children:"ACTIONS_UPLOAD_ARTIFACT"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"actions/upload-artifact at v7.0.1."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.AMANNN_ACTION_SEMANTIC_PULL_REQUEST",children:"AMANNN_ACTION_SEMANTIC_PULL_REQUEST"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"amannn/action-semantic-pull-request at v6.1.1."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.AWS_ACTIONS_CONFIGURE_AWS_CREDENTIALS",children:"AWS_ACTIONS_CONFIGURE_AWS_CREDENTIALS"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"aws-actions/configure-aws-credentials at v6.2.3 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.CODECOV_CODECOV_ACTION",children:"CODECOV_CODECOV_ACTION"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"codecov/codecov-action at v7.0.0 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.OVEN_SH_SETUP_BUN",children:"OVEN_SH_SETUP_BUN"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"oven-sh/setup-bun at v2.2.0."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.PETER_EVANS_CREATE_PULL_REQUEST",children:"PETER_EVANS_CREATE_PULL_REQUEST"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"peter-evans/create-pull-request at v8.1.1 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.PNPM_ACTION_SETUP",children:"PNPM_ACTION_SETUP"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"pnpm/action-setup at v6.0.10 (immutable)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.ActionRefs.property.SQREN_BACKPORT_GITHUB_ACTION",children:"SQREN_BACKPORT_GITHUB_ACTION"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"sqren/backport-github-action at v12.0.4."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_checkoutrequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_CHECKOUT"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_CHECKOUT",id:"projen.github.ActionRefs.property.ACTIONS_CHECKOUT"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_CHECKOUT: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/checkout at v7.0.1."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_create_github_app_tokenrequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_CREATE_GITHUB_APP_TOKEN"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_CREATE_GITHUB_APP_TOKEN",id:"projen.github.ActionRefs.property.ACTIONS_CREATE_GITHUB_APP_TOKEN"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_CREATE_GITHUB_APP_TOKEN: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/create-github-app-token at v3.2.0 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_dependency_review_actionrequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_DEPENDENCY_REVIEW_ACTION"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_DEPENDENCY_REVIEW_ACTION",id:"projen.github.ActionRefs.property.ACTIONS_DEPENDENCY_REVIEW_ACTION"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_DEPENDENCY_REVIEW_ACTION: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/dependency-review-action at v5.0.0."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_download_artifactrequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_DOWNLOAD_ARTIFACT"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_DOWNLOAD_ARTIFACT",id:"projen.github.ActionRefs.property.ACTIONS_DOWNLOAD_ARTIFACT"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_DOWNLOAD_ARTIFACT: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/download-artifact at v8.0.1."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_github_scriptrequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_GITHUB_SCRIPT"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_GITHUB_SCRIPT",id:"projen.github.ActionRefs.property.ACTIONS_GITHUB_SCRIPT"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_GITHUB_SCRIPT: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/github-script at v9.0.0."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_setup_dotnetrequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_SETUP_DOTNET"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_SETUP_DOTNET",id:"projen.github.ActionRefs.property.ACTIONS_SETUP_DOTNET"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_SETUP_DOTNET: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/setup-dotnet at v6.0.0 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_setup_gorequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_SETUP_GO"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_SETUP_GO",id:"projen.github.ActionRefs.property.ACTIONS_SETUP_GO"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_SETUP_GO: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/setup-go at v7.0.0 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_setup_javarequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_SETUP_JAVA"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_SETUP_JAVA",id:"projen.github.ActionRefs.property.ACTIONS_SETUP_JAVA"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_SETUP_JAVA: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/setup-java at v6.0.0 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_setup_noderequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_SETUP_NODE"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_SETUP_NODE",id:"projen.github.ActionRefs.property.ACTIONS_SETUP_NODE"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_SETUP_NODE: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{childre

1n:"actions/setup-node at v7.0.0 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_setup_pythonrequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_SETUP_PYTHON"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_SETUP_PYTHON",id:"projen.github.ActionRefs.property.ACTIONS_SETUP_PYTHON"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_SETUP_PYTHON: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/setup-python at v7.0.0 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_stalerequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_STALE"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_STALE",id:"projen.github.ActionRefs.property.ACTIONS_STALE"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_STALE: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/stale at v11.0.0 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"actions_upload_artifactrequired-",children:[(0,s.jsx)(n.code,{children:"ACTIONS_UPLOAD_ARTIFACT"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"ACTIONS_UPLOAD_ARTIFACT",id:"projen.github.ActionRefs.property.ACTIONS_UPLOAD_ARTIFACT"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly ACTIONS_UPLOAD_ARTIFACT: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"actions/upload-artifact at v7.0.1."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"amannn_action_semantic_pull_requestrequired-",children:[(0,s.jsx)(n.code,{children:"AMANNN_ACTION_SEMANTIC_PULL_REQUEST"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"AMANNN_ACTION_SEMANTIC_PULL_REQUEST",id:"projen.github.ActionRefs.property.AMANNN_ACTION_SEMANTIC_PULL_REQUEST"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly AMANNN_ACTION_SEMANTIC_PULL_REQUEST: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"amannn/action-semantic-pull-request at v6.1.1."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"aws_actions_configure_aws_credentialsrequired-",children:[(0,s.jsx)(n.code,{children:"AWS_ACTIONS_CONFIGURE_AWS_CREDENTIALS"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"AWS_ACTIONS_CONFIGURE_AWS_CREDENTIALS",id:"projen.github.ActionRefs.property.AWS_ACTIONS_CONFIGURE_AWS_CREDENTIALS"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly AWS_ACTIONS_CONFIGURE_AWS_CREDENTIALS: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"aws-actions/configure-aws-credentials at v6.2.3 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"codecov_codecov_actionrequired-",children:[(0,s.jsx)(n.code,{children:"CODECOV_CODECOV_ACTION"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"CODECOV_CODECOV_ACTION",id:"projen.github.ActionRefs.property.CODECOV_CODECOV_ACTION"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly CODECOV_CODECOV_ACTION: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"codecov/codecov-action at v7.0.0 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"oven_sh_setup_bunrequired-",children:[(0,s.jsx)(n.code,{children:"OVEN_SH_SETUP_BUN"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"OVEN_SH_SETUP_BUN",id:"projen.github.ActionRefs.property.OVEN_SH_SETUP_BUN"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly OVEN_SH_SETUP_BUN: 

1string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"oven-sh/setup-bun at v2.2.0."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"peter_evans_create_pull_requestrequired-",children:[(0,s.jsx)(n.code,{children:"PETER_EVANS_CREATE_PULL_REQUEST"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"PETER_EVANS_CREATE_PULL_REQUEST",id:"projen.github.ActionRefs.property.PETER_EVANS_CREATE_PULL_REQUEST"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly PETER_EVANS_CREATE_PULL_REQUEST: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"peter-evans/create-pull-request at v8.1.1 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pnpm_action_setuprequired-",children:[(0,s.jsx)(n.code,{children:"PNPM_ACTION_SETUP"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"PNPM_ACTION_SETUP",id:"projen.github.ActionRefs.property.PNPM_ACTION_SETUP"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly PNPM_ACTION_SETUP: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"pnpm/action-setup at v6.0.10 (immutable)."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"sqren_backport_github_actionrequired-",children:[(0,s.jsx)(n.code,{children:"SQREN_BACKPORT_GITHUB_ACTION"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"SQREN_BACKPORT_GITHUB_ACTION",id:"projen.github.ActionRefs.property.SQREN_BACKPORT_GITHUB_ACTION"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly SQREN_BACKPORT_GITHUB_ACTION: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"sqren/backport-github-action at v12.0.4."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"githubactionsprovider-",children:["GitHubActionsProvider ",(0,s.jsx)(n.a,{name:"GitHubActionsProvider",id:"projen.github.GitHubActionsProvider"})]}),"\n",(0,s.jsx)(n.p,{children:"Manage the versions used for GitHub Actions used in steps."}),"\n",(0,s.jsxs)(n.h4,{id:"initializers--16",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.GitHubActionsProvider.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.GitHubActionsProvider()\n"})}),"\n\n\n\n\n\n\n\n\n",(0,s.jsx)(n.table,{children:(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"methods--16",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubActionsProvider.get",children:"get"})})}),(0,s.jsx)(n.td,{children:"Resolve an action name to the version that should be used, taking into account any overrides."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GitHubActionsProvider.set",children:"set"})})}),(0,s.jsx)(n.td,{children:"Define an override for a given action."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"get-",children:[(0,s.jsx)(n.code,{children:"get"})," ",(0,s.jsx)(n.a,{name:"get",id:"projen.github.GitHubActionsProvider.get"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public get(action: string): string\n"})}),"\n",(0,s.jsx)(n.p,{children:"Resolve an action name to the version that should be used, taking into account any overrides."}),"\n",(0,s.jsxs)(n.h6,{id:"actionrequired-",children:[(0,s.jsx)(n.code,{children:"action"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"action",id:"projen.github.GitHubActionsProvider.get.parameter.action"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"set-",children:[(0,s.jsx)(n.code,{children:"set"})," ",(0,s.jsx)(n.a,{name:"set",id:"projen.github.GitHubActionsProvider.set"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public set(action: string, override: string): void\n"})}),"\n",(0,s.jsx)(n.p,{children:"Define an override for a given action."}),"\n",(0,s.jsx)(n.p,{children:"Specify the action name without a version to override all usages of the action.\nYou can also override a specific action version, by providing the version string.\nSpecific overrides take precedence over overrides without a version."}),"\n",(0,s.jsx)(n.p,{children:"If an override for the same action name is set multiple times, the last override is used."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.em,{children:"Example"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:'// Force any use of `actions/checkout` to use a pin a 

1specific commit\nproject.github.actions.set("actions/checkout", "actions/checkout@aaaaaa");\n\n// But pin usage of `v4` to a different commit\nproject.github.actions.set("actions/checkout@v6", "actions/checkout@ffffff");\n'})}),"\n",(0,s.jsxs)(n.h6,{id:"actionrequired--1",children:[(0,s.jsx)(n.code,{children:"action"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"action",id:"projen.github.GitHubActionsProvider.set.parameter.action"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"overriderequired-",children:[(0,s.jsx)(n.code,{children:"override"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"override",id:"projen.github.GitHubActionsProvider.set.parameter.override"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"githubcredentials-",children:["GithubCredentials ",(0,s.jsx)(n.a,{name:"GithubCredentials",id:"projen.github.GithubCredentials"})]}),"\n",(0,s.jsx)(n.p,{children:"Represents a method of providing GitHub API access for projen workflows."}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--16",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials.fromApp",children:"fromApp"})})}),(0,s.jsx)(n.td,{children:"Provide API access through a GitHub App."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials.fromPersonalAccessToken",children:"fromPersonalAccessToken"})})}),(0,s.jsx)(n.td,{children:"Provide API access through a GitHub personal access token."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"fromapp-",children:[(0,s.jsx)(n.code,{children:"fromApp"})," ",(0,s.jsx)(n.a,{name:"fromApp",id:"projen.github.GithubCredentials.fromApp"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.GithubCredentials.fromApp(options?: GithubCredentialsAppOptions)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Provide API access through a GitHub App."}),"\n",(0,s.jsx)(n.p,{children:"The GitHub App must be installed on the GitHub repo, its App ID and a\nprivate key must be added as secrets to the repo. The name of the secrets\ncan be specified here."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://projen.io/docs/integrations/github/#github-app",children:"https://projen.io/docs/integrations/github/#github-app"})}),"\n"]}),"\n",(0,s.jsxs)(n.h6,{id:"optionsoptional--15",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.GithubCredentials.fromApp.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentialsAppOptions",children:"GithubCredentialsAppOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"frompersonalaccesstoken-",children:[(0,s.jsx)(n.code,{children:"fromPersonalAccessToken"})," ",(0,s.jsx)(n.a,{name:"fromPersonalAccessToken",id:"projen.github.GithubCredentials.fromPersonalAccessToken"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.GithubCredentials.fromPersonalAccessToken(options?: GithubCredentialsPersonalAccessTokenOptions)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Provide API access through a GitHub personal access token."}),"\n",(0,s.jsx)(n.p,{children:"The token must be added as a secret to the GitHub repo, and the name of the\nsecret can be specified here."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token",children:"https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token"})}),"\n"]}),"\n",(0,s.jsxs)(n.h6,{id:"optionsoptional--16",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.GithubCredentials.fromPersonalAccessToken.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentialsPersonalAccessTokenOptions",children:"GithubCredentialsPersonalAccessTokenOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"properties--60",children:["Properties ",(0,s.jsx)(n.a,{name:"Properties",id:"Properties"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials.property.setupSteps",children:"setupSteps"})})}),(0,s.jsx)(n.td,{children:(0,s.jsxs)(n.code,{children:[(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]})}),(0,s.jsx)(n.td,{children:"Setup steps to obtain GitHub credentials."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials.property.tokenRef",children:"tokenRef"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The value to use in a workflow when a GitHub token is expected."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.GithubCredentials.property.environment",children:"environment"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"string"})}),(0,s.jsx)(n.td,{children:"The GitHub Actions environment the credentials have been added to."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"setupstepsrequired-",children:[(0,s.jsx)(n.code,{children:"setupSteps"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"setupSteps",id:"projen.github.GithubCredentials.property.setupSteps"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly setupSteps: JobStep[];\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStep",children:"JobStep"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Setup steps to obtain GitHub credentials."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tokenrefrequired-",children:[(0,s.jsx)(n.code,{children:"tokenRef"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"tokenRef",id:"projen.github.GithubCredentials.property.tokenRef"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly tokenRef: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The value to use in a workflow when a GitHub token is expected."}),"\n",(0,s.jsx)(n.p,{children:'This\ntypically looks like "${{ some.path.to.a.value }}".'}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"environmentoptional--5",children:[(0,s.jsx)(n.code,{children:"environment"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"environment",id:"projen.github.GithubCredentials.property.environment"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public readonly environment: string;\n"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The GitHub Actions environment the credentials have been added to."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"workflowactions-",children:["WorkflowActions ",(0,s.jsx)(n.a,{name:"WorkflowActions",id:"projen.github.WorkflowActions"})]}),"\n",(0,s.jsx)(n.p,{children:"A set of utility functions for creating GitHub actions in workflows."}

1),"\n",(0,s.jsxs)(n.h4,{id:"initializers--17",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.WorkflowActions.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.WorkflowActions()\n"})}),"\n\n\n\n\n\n\n\n\n",(0,s.jsx)(n.table,{children:(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--17",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.WorkflowActions.checkoutWithPatch",children:"checkoutWithPatch"})})}),(0,s.jsxs)(n.td,{children:["Checks out a repository and applies a git patch that was created using ",(0,s.jsx)(n.code,{children:"uploadGitPatch"}),"."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.WorkflowActions.createPullRequest",children:"createPullRequest"})})}),(0,s.jsx)(n.td,{children:"A step that creates a pull request based on the current repo state."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.WorkflowActions.uploadGitPatch",children:"uploadGitPatch"})})}),(0,s.jsxs)(n.td,{children:["Creates a .patch file from the current git diff and uploads it as an artifact. Use ",(0,s.jsx)(n.code,{children:"checkoutWithPatch"})," to download and apply in another job."]})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"checkoutwithpatch-",children:[(0,s.jsx)(n.code,{children:"checkoutWithPatch"})," ",(0,s.jsx)(n.a,{name:"checkoutWithPatch",id:"projen.github.WorkflowActions.checkoutWithPatch"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.WorkflowActions.checkoutWithPatch(options?: CheckoutWithPatchOptions)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks out a repository and applies a git patch that was created using ",(0,s.jsx)(n.code,{children:"uploadGitPatch"}),"."]}),"\n",(0,s.jsxs)(n.h6,{id:"optionsoptional--17",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.WorkflowActions.checkoutWithPatch.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutWithPatchOptions",children:"CheckoutWithPatchOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"createpullrequest-",children:[(0,s.jsx)(n.code,{children:"createPullRequest"})," ",(0,s.jsx)(n.a,{name:"createPullRequest",id:"projen.github.WorkflowActions.createPullRequest"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.WorkflowActions.createPullRequest(options: CreatePullRequestOptions)\n"})}),"\n",(0,s.jsx)(n.p,{children:"A step that creates a pull request based on the current repo state."}),"\n",(0,s.jsxs)(n.h6,{id:"optionsrequired--3",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.WorkflowActions.createPullRequest.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CreatePullRequestOptions",children:"CreatePullRequestOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"uploadgitpatch-",children:[(0,s.jsx)(n.code,{children:"uploadGitPatch"})," ",(0,s.jsx)(n.a,{name:"uploadGitPatch",id:"projen.github.WorkflowActions.uploadGitPatch"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.WorkflowActions.uploadGitPatch(options: UploadGitPatchOptions)\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Creates a .patch file from the current git diff and uploads it as an artifact. Use ",(0,s.jsx)(n.code,{children:"checkoutWithPatch"})," to download and apply in another job."]}),"\n",(0,s.jsx)(n.p,{children:"If a patch was uploaded, the action can optionally fail the job."}),"\n",(0,s.jsxs)(n.h6,{id:"optionsrequired--4",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.WorkflowActions.uploadGitPatch.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.UploadGitPatchOptions",children:"UploadGitPatchOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"workflowjobs-",children:["WorkflowJobs ",(0,s.jsx)(n.a,{name:"WorkflowJobs",id:"projen.github.WorkflowJobs"})]}),"\n",(0,s.jsx)(n.p,{children:"A set of utility functions for creating jobs in GitHub Workflows."}

1),"\n",(0,s.jsxs)(n.h4,{id:"initializers--18",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.WorkflowJobs.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.WorkflowJobs()\n"})}),"\n\n\n\n\n\n\n\n\n",(0,s.jsx)(n.table,{children:(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--18",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.WorkflowJobs.pullRequestFromPatch",children:"pullRequestFromPatch"})})}),(0,s.jsx)(n.td,{children:"Creates a pull request with the changes of a patch file."})]})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"pullrequestfrompatch-",children:[(0,s.jsx)(n.code,{children:"pullRequestFromPatch"})," ",(0,s.jsx)(n.a,{name:"pullRequestFromPatch",id:"projen.github.WorkflowJobs.pullRequestFromPatch"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.WorkflowJobs.pullRequestFromPatch(options: PullRequestFromPatchOptions)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Creates a pull request with the changes of a patch file."}),"\n",(0,s.jsxs)(n.h6,{id:"optionsrequired--5",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.WorkflowJobs.pullRequestFromPatch.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.PullRequestFromPatchOptions",children:"PullRequestFromPatchOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"workflowsteps-",children:["WorkflowSteps ",(0,s.jsx)(n.a,{name:"WorkflowSteps",id:"projen.github.WorkflowSteps"})]}),"\n",(0,s.jsx)(n.p,{children:"A collection of very commonly used, individual, GitHub Workflow Job steps."}),"\n",(0,s.jsxs)(n.h4,{id:"initializers--19",children:["Initializers ",(0,s.jsx)(n.a,{name:"Initializers",id:"projen.github.WorkflowSteps.Initializer"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\nnew github.WorkflowSteps()\n"})}),"\n\n\n\n\n\n\n\n\n",(0,s.jsx)(n.table,{children:(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h4,{id:"static-functions--19",children:["Static Functions ",(0,s.jsx)(n.a,{name:"Static Functions",id:"Static Functions"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.WorkflowSteps.checkout",children:"checkout"})})}),(0,s.jsx)(n.td,{children:"Checks out a repository."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.WorkflowSteps.downloadArtifact",children:"downloadArtifact"})})}),(0,s.jsx)(n.td,{children:"Downloads an artifact."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.WorkflowSteps.setupGitIdentity",children:"setupGitIdentity"})})}),(0,s.jsx)(n.td,{children:"Configures the git identity (user name and email)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.WorkflowSteps.tagExists",children:"tagExists"})})}),(0,s.jsx)(n.td,{children:"Checks if a tag exists."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.WorkflowSteps.uploadArtifact",children:"uploadArtifact"})})}),(0,s.jsx)(n.td,{children:"Uploads an artifact."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"checkout-",children:[(0,s.jsx)(n.code,{children:"checkout"})," ",(0,s.jsx)(n.a,{name:"checkout",id:"projen.github.WorkflowSteps.checkout"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.WorkflowSteps.checkout(options?: CheckoutOptions)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Checks out a repository."}),"\n",(0,s.jsxs)(n.h6,{id:"optionsoptional--18",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.WorkflowSteps.checkout.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.CheckoutOptions",children:"CheckoutOptions"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Options to configure the ",(0,s.jsx)(n.code,{children:"checkout"})," JobStep."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"downloadartifact-",children:[(0,s.jsx)(n.code,{children:"downloadArtifact"})," ",(0,s.jsx)(n.a,{name:"downloadArtifact",id:"projen.github.WorkflowSteps.downloadArtifact"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.WorkflowSteps.downloadArtifact(options?: DownloadArtifactOptions)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Downloads an artifact."}),"\n",(0,s.jsxs)(n.h6,{id:"optionsoptional--19",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Optional"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.WorkflowSteps.downloadArtifact.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.DownloadArtifactOptions",children:"DownloadArtifactOptions"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Options to configure the ",(0,s.jsx)(n.code,{children:"download-artifact"})," JobStep."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"setupgitidentity-",children:[(0,s.jsx)(n.code,{children:"setupGitIdentity"})," ",(0,s.jsx)(n.a,{name:"setupGitIdentity",id:"projen.github.WorkflowSteps.setupGitIdentity"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.WorkflowSteps.setupGitIdentity(options: SetupGitIdentityOptions)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Configures the git identity (user name and email)."}),"\n",(0,s.jsxs)(n.h6,{id:"optionsrequired--6",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.WorkflowSteps.setupGitIdentity.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.SetupGitIdentityOptions",children:"SetupGitIdentityOptions"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Options to configure the git identity JobStep."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"tagexists-",children:[(0,s.jsx)(n.code,{children:"tagExists"})," ",(0,s.jsx)(n.a,{name:"tagExists",id:"projen.github.WorkflowSteps.tagExists"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.WorkflowSteps.tagExists(tag: string, options: JobStepConfiguration)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Checks if a tag exists."}),"\n",(0,s.jsx)(n.p,{children:'Requires a checkout step to have been run before this step with "fetch-depth" set to "0".'}),"\n",(0,s.jsx)(n.p,{children:"Outputs:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.code,{children:"exists"}),": A string value of 'true' or 'false' indicating if the tag exists."]}),"\n"]}),"\n",(0,s.jsxs)(n.h6,{id:"tagrequired-",children:[(0,s.jsx)(n.code,{children:"tag"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"tag",id:"projen.github.WorkflowSteps.tagExists.parameter.tag"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," string"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The tag to check."}),"\n",(0,s.jsx)(n.p,{children:"You may use valid bash code instead of a literal string in this field."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h6,{id:"optionsrequired--7",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.WorkflowSteps.tagExists.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.workflows.JobStepConfiguration",children:"JobStepConfiguration"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Options to configure the ",(0,s.jsx)(n.code,{children:"tag-exists"})," JobStep."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"uploadartifact-",children:[(0,s.jsx)(n.code,{children:"uploadArtifact"})," ",(0,s.jsx)(n.a,{name:"uploadArtifact",id:"projen.github.WorkflowSteps.uploadArtifact"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"import { github } from 'projen'\n\ngithub.WorkflowSteps.uploadArtifact(options: UploadArtifactOptions)\n"})}),"\n",(0,s.jsx)(n.p,{children:"Uploads an artifact."}),"\n",(0,s.jsxs)(n.h6,{id:"optionsrequired--8",children:[(0,s.jsx)(n.code,{children:"options"}),(0,s.jsx)(n.sup,{children:"Required"})," ",(0,s.jsx)(n.a,{name:"options",id:"projen.github.WorkflowSteps.uploadArtifact.parameter.options"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Type:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.UploadArtifactOptions",children:"UploadArtifactOptions"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Options to configure the ",(0,s.jsx)(n.code,{children:"upload-artifact"})," JobStep."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h2,{id:"protocols-",children:["Protocols ",(0,s.jsx)(n.a,{name:"Protocols",id:"Protocols"})]}),"\n",(0,s.jsxs)(n.h3,{id:"iaddconditionslater-",children:["IAddConditionsLater ",(0,s.jsx)(n.a,{name:"IAddConditionsLater",id:"projen.github.IAddConditionsLater"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.em,{children:"Implemented By:"})," ",(0,s.jsx)(n.a,{href:"#projen.github.IAddConditionsLater",children:"IAddConditionsLater"})]}),"\n"]}),"\n",(0,s.jsxs)(n.h4,{id:"methods--17",children:["Methods ",(0,s.jsx)(n.a,{name:"Methods",id:"Methods"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.IAddConditionsLater.render",children:"render"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"render-",children:[(0,s.jsx)(n.code,{children:"render"})," ",(0,s.jsx)(n.a,{name:"render",id:"projen.github.IAddConditionsLater.render"})]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-typescript",children:"public render(): string[]\n"})}),"\n",(0,s.jsxs)(n.h2,{id:"enums-",children:["Enums ",(0,s.jsx)(n.a,{name:"Enums",id:"Enums"})]}),"\n",(0,s.jsxs)(n.h3,{id:"checkoutsubmodules-",children:["CheckoutSubmodules ",(0,s.jsx)(n.a,{name:"CheckoutSubmodules",id:"projen.github.CheckoutSubmodules"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether to checkout Git submodules in CI workflows."}),"\n",(0,s.jsxs)(n.h4,{id:"members-",children:["Members ",(0,s.jsx)(n.a,{name:"Members",

1id:"Members"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules.DISABLED",children:"DISABLED"})})}),(0,s.jsx)(n.td,{children:"Don't checkout submodules."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules.ENABLED",children:"ENABLED"})})}),(0,s.jsx)(n.td,{children:"Checkout only top-level submodules."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.CheckoutSubmodules.RECURSIVE",children:"RECURSIVE"})})}),(0,s.jsx)(n.td,{children:"Checkout submodules recursively."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"disabled-",children:[(0,s.jsx)(n.code,{children:"DISABLED"})," ",(0,s.jsx)(n.a,{name:"DISABLED",id:"projen.github.CheckoutSubmodules.DISABLED"})]}),"\n",(0,s.jsx)(n.p,{children:"Don't checkout submodules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"enabled-",children:[(0,s.jsx)(n.code,{children:"ENABLED"})," ",(0,s.jsx)(n.a,{name:"ENABLED",id:"projen.github.CheckoutSubmodules.ENABLED"})]}),"\n",(0,s.jsx)(n.p,{children:"Checkout only top-level submodules."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"recursive-",children:[(0,s.jsx)(n.code,{children:"RECURSIVE"})," ",(0,s.jsx)(n.a,{name:"RECURSIVE",id:"projen.github.CheckoutSubmodules.RECURSIVE"})]}),"\n",(0,s.jsx)(n.p,{children:"Checkout submodules recursively."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotgroupappliesto-",children:["DependabotGroupAppliesTo ",(0,s.jsx)(n.a,{name:"DependabotGroupAppliesTo",id:"projen.github.DependabotGroupAppliesTo"})]}),"\n",(0,s.jsx)(n.p,{children:"The type of update a group applies to."}),"\n",(0,s.jsxs)(n.h4,{id:"members--1",children:["Members ",(0,s.jsx)(n.a,{name:"Members",id:"Members"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupAppliesTo.VERSION_UPDATES",children:"VERSION_UPDATES"})})}),(0,s.jsx)(n.td,{children:"Apply only to version updates."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupAppliesTo.SECURITY_UPDATES",children:"SECURITY_UPDATES"})})}),(0,s.jsx)(n.td,{children:"Apply only to security updates."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"version_updates-",children:[(0,s.jsx)(n.code,{children:"VERSION_UPDATES"})," ",(0,s.jsx)(n.a,{name:"VERSION_UPDATES",id:"projen.github.DependabotGroupAppliesTo.VERSION_UPDATES"})]}),"\n",(0,s.jsx)(n.p,{children:"Apply only to version updates."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"security_updates-",children:[(0,s.jsx)(n.code,{children:"SECURITY_UPDATES"})," ",(0,s.jsx)(n.a,{name:"SECURITY_UPDATES",id:"projen.github.DependabotGroupAppliesTo.SECURITY_UPDATES"})]}),"\n",(0,s.jsx)(n.p,{children:"Apply only to security updates."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotgroupdependencytype-",children:["DependabotGroupDependencyType ",(0,s.jsx)(n.a,{name:"DependabotGroupDependencyType",id:"projen.github.DependabotGroupDependencyType"})]}),"\n",(0,s.jsx)(n.p,{children:"The type of dependency a group may be limited to."}),"\n",(0,s.jsxs)(n.h4,{id:"members--2",children:["Members ",(0,s.jsx)(n.a,{name:"Members",id:"Members"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupDependencyType.DEVELOPMENT",children:"DEVELOPMENT"})})}

1),(0,s.jsx)(n.td,{children:'Include only dependencies in the "Development dependency group".'})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupDependencyType.PRODUCTION",children:"PRODUCTION"})})}),(0,s.jsx)(n.td,{children:'Include only dependencies in the "Production dependency group".'})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"development-",children:[(0,s.jsx)(n.code,{children:"DEVELOPMENT"})," ",(0,s.jsx)(n.a,{name:"DEVELOPMENT",id:"projen.github.DependabotGroupDependencyType.DEVELOPMENT"})]}),"\n",(0,s.jsx)(n.p,{children:'Include only dependencies in the "Development dependency group".'}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"production-",children:[(0,s.jsx)(n.code,{children:"PRODUCTION"})," ",(0,s.jsx)(n.a,{name:"PRODUCTION",id:"projen.github.DependabotGroupDependencyType.PRODUCTION"})]}),"\n",(0,s.jsx)(n.p,{children:'Include only dependencies in the "Production dependency group".'}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotgroupupdatetype-",children:["DependabotGroupUpdateType ",(0,s.jsx)(n.a,{name:"DependabotGroupUpdateType",id:"projen.github.DependabotGroupUpdateType"})]}),"\n",(0,s.jsx)(n.p,{children:"The semantic versioning levels a group may be limited to."}),"\n",(0,s.jsxs)(n.h4,{id:"members--3",children:["Members ",(0,s.jsx)(n.a,{name:"Members",id:"Members"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupUpdateType.MAJOR",children:"MAJOR"})})}),(0,s.jsx)(n.td,{children:"Include major releases."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupUpdateType.MINOR",children:"MINOR"})})}),(0,s.jsx)(n.td,{children:"Include minor releases."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotGroupUpdateType.PATCH",children:"PATCH"})})}),(0,s.jsx)(n.td,{children:"Include patch releases."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"major-",children:[(0,s.jsx)(n.code,{children:"MAJOR"})," ",(0,s.jsx)(n.a,{name:"MAJOR",id:"projen.github.DependabotGroupUpdateType.MAJOR"})]}),"\n",(0,s.jsx)(n.p,{children:"Include major releases."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"minor-",children:[(0,s.jsx)(n.code,{children:"MINOR"})," ",(0,s.jsx)(n.a,{name:"MINOR",id:"projen.github.DependabotGroupUpdateType.MINOR"})]}),"\n",(0,s.jsx)(n.p,{children:"Include minor releases."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"patch-",children:[(0,s.jsx)(n.code,{children:"PATCH"})," ",(0,s.jsx)(n.a,{name:"PATCH",id:"projen.github.DependabotGroupUpdateType.PATCH"})]}),"\n",(0,s.jsx)(n.p,{children:"Include patch releases."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotregistrytype-",children:["DependabotRegistryType ",(0,s.jsx)(n.a,{name:"DependabotRegistryType",id:"projen.github.DependabotRegistryType"})]}),"\n",(0,s.jsx)(n.p,{children:"Each configuration type requires you to provide particular settings."}),"\n",(0,s.jsx)(n.p,{children:"Some types allow more than one way to connect"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#configuration-options-for-private-registries",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#configuration-options-for-private-registries"})}),"\n"]}),"\n",(0,s.jsxs)(n.h4,{id:"members--4",children:["Members ",(0,s.jsx)(n.a,{name:"Members",

1id:"Members"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType.COMPOSER_REGISTRY",children:"COMPOSER_REGISTRY"})})}),(0,s.jsx)(n.td,{children:"The composer-repository type supports username and password."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType.DOCKER_REGISTRY",children:"DOCKER_REGISTRY"})})}),(0,s.jsx)(n.td,{children:"The docker-registry type supports username and password."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType.GIT",children:"GIT"})})}),(0,s.jsx)(n.td,{children:"The git type supports username and password."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType.HEX_ORGANIZATION",children:"HEX_ORGANIZATION"})})}),(0,s.jsx)(n.td,{children:"The hex-organization type supports organization and key."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType.MAVEN_REPOSITORY",children:"MAVEN_REPOSITORY"})})}),(0,s.jsx)(n.td,{children:"The maven-repository type supports username and password, or token."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType.NPM_REGISTRY",children:"NPM_REGISTRY"})})}),(0,s.jsx)(n.td,{children:"The npm-registry type supports username and password, or token."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType.NUGET_FEED",children:"NUGET_FEED"})})}),(0,s.jsx)(n.td,{children:"The nuget-feed type supports username and password, or token."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType.PYTHON_INDEX",children:"PYTHON_INDEX"})})}),(0,s.jsx)(n.td,{children:"The python-index type supports username and password, or token."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType.RUBYGEMS_SERVER",children:"RUBYGEMS_SERVER"})})}),(0,s.jsx)(n.td,{children:"The rubygems-server type supports username and password, or token."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotRegistryType.TERRAFORM_REGISTRY",children:"TERRAFORM_REGISTRY"})})}),(0,s.jsx)(n.td,{children:"The terraform-registry type supports a token."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"composer_registry-",children:[(0,s.jsx)(n.code,{children:"COMPOSER_REGISTRY"})," ",(0,s.jsx)(n.a,{name:"COMPOSER_REGISTRY",id:"projen.github.DependabotRegistryType.COMPOSER_REGISTRY"})]}),"\n",(0,s.jsx)(n.p,{children:"The composer-repository type supports username and password."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#composer-repository",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#composer-repository"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"docker_registry-",children:[(0,s.jsx)(n.code,{children:"DOCKER_REGISTRY"})," ",(0,s.jsx)(n.a,{name:"DOCKER_REGISTRY",id:"projen.github.DependabotRegistryType.DOCKER_REGISTRY"})]}),"\n",(0,s.jsx)(n.p,{children:"The docker-registry type supports username and password."}),"\n",(0,s.jsx)(n.p,{children:"The docker-registry type can also be used to pull from Amazon ECR using static AWS credentials"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#docker-registry",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#docker-registry"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"git-",children:[(0,s.jsx)(n.code,{children:"GIT"})," ",(0,s.jsx)(n.a,{name:"GIT",id:"projen.github.DependabotRegistryType.GIT"})]}),"\n",(0,s.jsx)(n.p,{children:"The git type supports username and password."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#git",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#git"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"hex_organization-",children:[(0,s.jsx)(n.code,{children:"HEX_ORGANIZATION"})," ",(0,s.jsx)(n.a,{name:"HEX_ORGANIZATION",id:"projen.github.DependabotRegistryType.HEX_ORGANIZATION"})]}),"\n",(0,s.jsx)(n.p,{children:"The hex-organization type supports organization and key."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#hex-organization",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#hex-organization"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"maven_repository-",children:[(0,s.jsx)(n.code,{children:"MAVEN_REPOSITORY"})," ",(0,s.jsx)(n.a,{name:"MAVEN_REPOSITORY",id:"projen.github.DependabotRegistryType.MAVEN_REPOSITORY"})]}),"\n",(0,s.jsx)(n.p,{children:"The maven-repository type supports username and password, or token."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#maven-repository",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#maven-repository"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"npm_registry-",children:[(0,s.jsx)(n.code,{children:"NPM_REGISTRY"})," ",(0,s.jsx)(n.a,{name:"NPM_REGISTRY",id:"projen.github.DependabotRegistryType.NPM_REGISTRY"})]}),"\n",(0,s.jsx)(n.p,{children:"The npm-registry type supports username and password, or token."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#npm

1-registry",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#npm-registry"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"nuget_feed-",children:[(0,s.jsx)(n.code,{children:"NUGET_FEED"})," ",(0,s.jsx)(n.a,{name:"NUGET_FEED",id:"projen.github.DependabotRegistryType.NUGET_FEED"})]}),"\n",(0,s.jsx)(n.p,{children:"The nuget-feed type supports username and password, or token."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#nuget-feed",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#nuget-feed"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"python_index-",children:[(0,s.jsx)(n.code,{children:"PYTHON_INDEX"})," ",(0,s.jsx)(n.a,{name:"PYTHON_INDEX",id:"projen.github.DependabotRegistryType.PYTHON_INDEX"})]}),"\n",(0,s.jsx)(n.p,{children:"The python-index type supports username and password, or token."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#python-index",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#python-index"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"rubygems_server-",children:[(0,s.jsx)(n.code,{children:"RUBYGEMS_SERVER"})," ",(0,s.jsx)(n.a,{name:"RUBYGEMS_SERVER",id:"projen.github.DependabotRegistryType.RUBYGEMS_SERVER"})]}),"\n",(0,s.jsx)(n.p,{children:"The rubygems-server type supports username and password, or token."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#rubygems-server",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#rubygems-server"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"terraform_registry-",children:[(0,s.jsx)(n.code,{children:"TERRAFORM_REGISTRY"})," ",(0,s.jsx)(n.a,{name:"TERRAFORM_REGISTRY",id:"projen.github.DependabotRegistryType.TERRAFORM_REGISTRY"})]}),"\n",(0,s.jsx)(n.p,{children:"The terraform-registry type supports a token."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#terraform-registry",children:"https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#terraform-registry"})}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"dependabotscheduleinterval-",children:["DependabotScheduleInterval ",(0,s.jsx)(n.a,{name:"DependabotScheduleInterval",id:"projen.github.DependabotScheduleInterval"})]}),"\n",(0,s.jsx)(n.p,{children:"How often to check for new versions and raise pull requests for version updates."}),"\n",(0,s.jsxs)(n.h4,{id:"members--5",children:["Members ",(0,s.jsx)(n.a,{name:"Members",id:"Members"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotScheduleInterval.DAILY",children:"DAILY"})})}),(0,s.jsx)(n.td,{children:"Runs on every weekday, Monday to Frid

1ay."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotScheduleInterval.WEEKLY",children:"WEEKLY"})})}),(0,s.jsx)(n.td,{children:"Runs once each week."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.DependabotScheduleInterval.MONTHLY",children:"MONTHLY"})})}),(0,s.jsx)(n.td,{children:"Runs once each month."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"daily-",children:[(0,s.jsx)(n.code,{children:"DAILY"})," ",(0,s.jsx)(n.a,{name:"DAILY",id:"projen.github.DependabotScheduleInterval.DAILY"})]}),"\n",(0,s.jsx)(n.p,{children:"Runs on every weekday, Monday to Friday."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"weekly-",children:[(0,s.jsx)(n.code,{children:"WEEKLY"})," ",(0,s.jsx)(n.a,{name:"WEEKLY",id:"projen.github.DependabotScheduleInterval.WEEKLY"})]}),"\n",(0,s.jsx)(n.p,{children:"Runs once each week."}),"\n",(0,s.jsx)(n.p,{children:"By default, this is on Monday."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"monthly-",children:[(0,s.jsx)(n.code,{children:"MONTHLY"})," ",(0,s.jsx)(n.a,{name:"MONTHLY",id:"projen.github.DependabotScheduleInterval.MONTHLY"})]}),"\n",(0,s.jsx)(n.p,{children:"Runs once each month."}),"\n",(0,s.jsx)(n.p,{children:"This is on the first day of the month."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"mergemethod-",children:["MergeMethod ",(0,s.jsx)(n.a,{name:"MergeMethod",id:"projen.github.MergeMethod"})]}),"\n",(0,s.jsx)(n.p,{children:"The merge method used to add the PR to the merge queue."}),"\n",(0,s.jsx)(n.p,{children:"Behavior can be further configured in repository settings."}),"\n",(0,s.jsxs)(n.h4,{id:"members--6",children:["Members ",(0,s.jsx)(n.a,{name:"Members",id:"Members"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeMethod.SQUASH",children:"SQUASH"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeMethod.MERGE",children:"MERGE"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.MergeMethod.REBASE",children:"REBASE"})})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.em,{children:"No description."})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"squash-",children:[(0,s.jsx)(n.code,{children:"SQUASH"})," ",(0,s.jsx)(n.a,{name:"SQUASH",id:"projen.github.MergeMethod.SQUASH"})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"merge-",children:[(0,s.jsx)(n.code,{children:"MERGE"})," ",(0,s.jsx)(n.a,{name:"MERGE",id:"projen.github.MergeMethod.MERGE"})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"rebase-",children:[(0,s.jsx)(n.code,{children:"REBASE"})," ",(0,s.jsx)(n.a,{name:"REBASE",id:"projen.github.MergeMethod.REBASE"})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h3,{id:"versioningstrategy-",children:["VersioningStrategy ",(0,s.jsx)(n.a,{name:"VersioningStrategy",id:"projen.github.VersioningStrategy"})]}),"\n",(0,s.jsx)(n.p,{children:"The strategy to use when edits manifest and lock files."}),"\n",(0,s.jsxs)(n.h4,{id:"members--7",children:["Members ",(0,s.jsx)(n.a,{name:"Members",id:"Members"})]}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Name"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.VersioningStrategy.LOCKFILE_ONLY",children:"LOCKFILE_ONLY"})})}),(0,s.jsx)(n.td,{children:"Only create pull requests to update lockfiles updates."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.VersioningStrategy.AUTO",children:"AUTO"})})}),(0,s.jsx)(n.td,{children:"- For apps, the version requirements are increased."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.VersioningStrategy.WIDEN",children:"WIDEN"})})}),(0,s.jsx)(n.td,{children:"Relax the version requirement to include both the new and old version, when possible."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.VersioningStrategy.INCREASE",children:"INCREASE"})})}),(0,s.jsx)(n.td,{children:"Always increase the version requirement to match the new version."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:(0,s.jsx)(n.a,{href:"#projen.github.VersioningStrategy.INCREASE_IF_NECESSARY",children:"INCREASE_IF_NECESSARY"})})}),(0,s.jsx)(n.td,{children:"Increase the version requirement only when required by the new version."})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"lockfile_only-",children:[(0,s.jsx)(n.code,{children:"LOCKFILE_ONLY"})," ",(0,s.jsx)(n.a,{name:"LOCKFILE_ONLY",id:"projen.github.VersioningStrategy.LOCKFILE_ONLY"})]}),"\n",(0,s.jsx)(n.p,{children:"Only create pull requests to update lockfiles updates."}),"\n",(0,s.jsx)(n.p,{children:"Ignore any new\nversions that would require package manifest changes."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"auto-",children:[(0,s.jsx)(n.code,{children:"AUTO"})," ",(0,s.jsx)(n.a,{name:"AUTO",id:"projen.github.VersioningStrategy.AUTO"})]}),"\n",(0,s.jsx)(n.p,{children:"For apps, the version requirements are increased."}),"\n",(0,s.jsx)(n.p,{children:"For libraries, the range of versions is widened."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"widen-",children:[(0,s.jsx)(n.code,{children:"WIDEN"})," ",(0,s.jsx)(n.a,{name:"WIDEN",id:"projen.github.VersioningStrategy.WIDEN"})]}),"\n",(0,s.jsx)(n.p,{children:"Relax the version requirement to include both the new and old version, when possible."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"increase-",children:[(0,s.jsx)(n.code,{children:"INCREASE"})," ",(0,s.jsx)(n.a,{name:"INCREASE",id:"projen.github.VersioningStrategy.INCREASE"})]}),"\n",(0,s.jsx)(n.p,{children:"Always increase the version requirement to match the new version."}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h5,{id:"increase_if_necessary-",children:[(0,s.jsx)(n.code,{children:"INCREASE_IF_NECESSARY"})," ",(0,s.jsx)(n.a,{name:"INCREASE_IF_NECESSARY",id:"projen.github.VersioningStrategy.INCREASE_IF_NECESSARY"})]}),"\n",(0,s.jsx)(n.p,{children:"Increase the version requirement only when required by the new version."}),"\n",(0,s.jsx)(n.hr,{})]})}function a(e={}){let{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},8453(e,n,i){i.d(n,{R:()=>o,x:()=>d});var r=i(6540);let s={},t=r.createContext(s);function o(e){let n=r.useContext(t);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]);