Skip to content

docs: Add change-pr-state automation action documentation #839

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

Merged
vim-zz merged 2 commits into from
Jan 19, 2026
+31 −0
Merged

docs: Add change-pr-state automation action documentation #839

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2658177
docs: Add change-pr-state automation action documentation
vim-zz Jan 19, 2026
6f4a583
docs: Add explicit triggers requirement note for change-pr-state
vim-zz Jan 19, 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
31 changes: 31 additions & 0 deletions docs/automation-actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ For all other actions, gitStream executes the actions in the order they are list
- [`add-reviewers`](#add-reviewers) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
- [`add-thread`](#add-thread) :fontawesome-brands-gitlab:
- [`approve`](#approve) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
- [`change-pr-state`](#change-pr-state) :fontawesome-brands-github: :fontawesome-brands-gitlab:
- [`close`](#close) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
- [`code-review`](#code-review) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
- [`describe-changes`](#describe-changes) :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
Expand Down Expand Up @@ -261,6 +262,36 @@ automations:
- action: approve@v1
```

#### `change-pr-state` :fontawesome-brands-github: :fontawesome-brands-gitlab:

This action, once triggered, updates the PR state between draft and ready for review.

!!! note "Explicit Triggers Required for Draft PRs"
Since gitStream does not run on draft PRs by default, this action requires the use of [explicit triggers](execution-model.md#explicit-triggers) to function properly. Define triggers using the `on` parameter at the automation level to specify when the automation should evaluate draft PRs.

<div class="filter-details" markdown=1>

| Args | Usage | Type | Description |
| --- | --- | --- | --- |
| `draft` | Optional | Bool | When `true`, convert the PR to Draft. When `false`, mark the PR as Ready for review. |

</div>

```yaml+jinja title="example"
automations:
ready_for_review:
# Explicit triggers required to work with draft PRs
on:
- label_added
- pr_created
if:
- true
run:
- action: change-pr-state@v1
args:
draft: false
```

#### `close` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:

This action, once triggered, closes the PR without merging.
Expand Down