Skip to content

fix: require first merged PR message variable #178

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
vitormattos merged 4 commits into from
Sep 23, 2026
Merged

fix: require first merged PR message variable #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
375d619
fix: require repository message variable
vitormattos Sep 23, 2026
de71991
test: require repository message variable
vitormattos Sep 23, 2026
74a9839
docs: require first merged PR message variable
vitormattos Sep 23, 2026
6ed0166
test: target first merged PR fallback assertion
vitormattos Sep 23, 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
14 changes: 8 additions & 6 deletions docs/first-merged-pr-comment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,14 @@ publishing a partially rendered message.

## Repository configuration

The organization workflow template reads the optional repository variable
`FIRST_MERGED_PR_MESSAGE`. If it is absent, the installed workflow uses a
minimal generic message.

A consumer can put its entire Markdown message in that single variable. For
example:
The organization workflow template requires the repository Actions variable
`FIRST_MERGED_PR_MESSAGE`. The workflow passes that variable directly to the
action. If it is absent or empty, the action fails instead of publishing a
fallback message.

Configure the variable under **Settings → Secrets and variables → Actions →
Variables**. A consumer can put its entire Markdown message in that single
variable. For example:

```text
Thanks {contributor_mention}! Your first pull request to {repository_name} has been merged.
Expand Down
11 changes: 9 additions & 2 deletions tests/test_first_merged_pr_comment_action.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,8 +230,15 @@ def test_workflow_template_only_exposes_message_configuration(self) -> None:
workflow = (
ROOT / "workflow-templates" / "first-merged-pr-comment.yml"
).read_text(encoding="utf-8")
self.assertIn("vars.FIRST_MERGED_PR_MESSAGE", workflow)
self.assertIn("message-template:", workflow)
self.assertIn(
"message-template: ${{ vars.FIRST_MERGED_PR_MESSAGE }}",
workflow,
)
self.assertNotIn("env:\n FIRST_MERGED_PR_MESSAGE", workflow)
self.assertNotIn(
"Thanks {contributor_mention}! Your first pull request",
workflow,
)
self.assertNotIn("survey", workflow.lower())
self.assertNotIn("community", workflow.lower())
self.assertNotIn("good first issue", workflow.lower())
Expand Down
7 changes: 1 addition & 6 deletions workflow-templates/first-merged-pr-comment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,6 @@ jobs:
permissions:
pull-requests: write

env:
FIRST_MERGED_PR_MESSAGE: >-
${{ vars.FIRST_MERGED_PR_MESSAGE ||
'Thanks {contributor_mention}! Your first pull request to {repository_name} has been merged.' }}

steps:
# pull_request_target is intentionally used without checkout. Nothing
# from the pull request head is downloaded or executed.
Expand All @@ -52,4 +47,4 @@ jobs:
github-token: ${{ github.token }}
pull-request-number: >-
${{ github.event.pull_request.number || inputs.pull_request_number }}
message-template: ${{ env.FIRST_MERGED_PR_MESSAGE }}
message-template: ${{ vars.FIRST_MERGED_PR_MESSAGE }}
Loading