Skip to content

Document reviewStackLabels for conditionally creating review stacks #18693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zacdirect wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Document reviewStackLabels for conditionally creating review stacks #18693

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e45aab2
Document reviewStackLabels for conditionally creating review stacks
zacdirect Apr 24, 2026
10e6bc4
PR feedback
zacdirect Apr 24, 2026
2836677
Update content/docs/deployments/deployments/review-stacks.md
zacdirect Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions content/docs/deployments/deployments/review-stacks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,3 +323,29 @@ const prMigrationSettings = new pulumiservice.DeploymentSettings("prMigrationSet
});

```

### Gating review stacks by GitHub label

By default, every pull request against a configured branch creates a review stack. To restrict this to a subset of pull requests, set `reviewStackLabels` on the GitHub Deployment Settings to a list of labels. Review stacks are then created only for pull requests carrying at least one matching label. Matching is case-sensitive, and labels added after a pull request is opened also trigger creation.
Comment thread
zacdirect marked this conversation as resolved.
Outdated

The following example shows how to configure this pattern using the [Pulumi Cloud Service provider](/registry/packages/pulumiservice):

```typescript
const reviewSettings = new pulumiservice.DeploymentSettings("reviewSettings", {
organization: pulumi.getOrganization(),
project: "your project",
stack: "pr",
github: {
pullRequestTemplate: true,
repository: "pulumi/deployment-automation",
// only create review stacks for PRs with one of these labels
reviewStackLabels: ["review-stack", "reviewStack", "rs"],
},
sourceContext: {
git: {
branch: "refs/heads/main",
repoDir: "pulumi-pet-shop",
},
},
});
```
Loading