| name | create-pr |
| description | Use when opening a pull request in camunda-docs. Covers reading the PR template, marking applicable checklist items, choosing labels, constructing the gh pr create command with --body-file, and adding the PR to the Documentation Team project. |
| user-invocable | true |
| argument-hint | <brief description of the PR> |
/create-pr — open a pull request for camunda-docs
Follow these steps in order. Do not skip or reorder them.
Step 1: Read the PR template
- Read the PR template at
.github/pull_request_template.md:
cat .github/pull_request_template.md
-
Replace the HTML comment block inside ## Description with the description of the changes the PR introduces.
-
In ## When should this change go live? and ## PR Checklist, check ([x]) the items that apply to this PR. Do not add, remove, or reword any checklist items or HTML comments in these sections.
Step 2: Add labels
- List all the available labels in the repo:
gh label list
-
Add any labels that apply to this PR to communicate the component, version, and priority. PRs without labels may be triaged slowly.
-
Add the deploy label to trigger a preview site deployment. Do this only for large or complex changes, or when the PR author explicitly requests it.
Step 3: Create the PR
-
Write the body to a temp file because the PR template contains backticks and special characters that make an inline --body argument unreliable.
-
Pass it with --body-file and capture the PR URL. For example:
cat > /tmp/pr-body.md << 'PREOF'
[full PR body here]
PREOF
PR_URL=$(gh pr create \
--title "..." \
--body-file /tmp/pr-body.md \
--label "LABEL_A" \
--label "LABEL_B")
echo "$PR_URL"
-
Follow the commit message conventions in .github/instructions/repo.instructions.md § 4 (Code formatting and commits) for the PR title format.
-
Add the PR to the Documentation Team GitHub project using the URL captured above:
gh pr edit "$PR_URL" --add-project "Documentation Team"
