Comment PR newly made tags

[nchiasson-dgi]

Summary by CodeRabbit

• New Features
  • Added optional comment-pr input to automatically post the newly created tag to the initiating pull request (enabled by default).
  • Updated tag output to include the version tag value.
  • When enabled, the action will post a PR comment linking the newly minted tag.

[coderabbitai]

Walkthrough

The pull request updates action.yml: adds an optional input comment-pr (default: true) to control whether the initiating PR is commented with the newly created tag; adds a conditional composite step pr-update that runs gh pr comment when enabled; and exposes tag output value: ${{ steps.tag.outputs.version_tag }}.

Changes

Cohort / File(s)	Summary
Action Configuration action.yml	Added optional input comment-pr (required: false, default: true); added conditional composite step pr-update that runs when ${{ inputs.comment-pr }} is true and executes gh pr comment with GH_TOKEN: ${{ github.token }} to post a PR comment linking the new tag; updated public output tag to include value: ${{ steps.tag.outputs.version_tag }}.

Sequence Diagram

sequenceDiagram
    participant User as GitHub Action Caller
    participant Action as Composite Action (action.yml)
    participant TagStep as Tagging Step
    participant GH as GitHub CLI (gh)

    User->>Action: trigger (inputs, including comment-pr)
    Action->>TagStep: run tag creation
    TagStep-->>Action: outputs.version_tag
    alt inputs.comment-pr == true
        Action->>GH: run `gh pr comment` (env GH_TOKEN)
        GH-->>Action: comment posted
    else inputs.comment-pr == false
        Action-->>Action: skip pr-update
    end
    Action-->>User: output `tag.value` = version_tag

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Check comment-pr default and description.
• Verify gh pr comment command syntax, quoting, and environment variable usage.
• Confirm steps.tag.outputs.version_tag matches the tag-producing step's output name.
• Ensure conditional if: ${{ inputs.comment-pr }} is placed correctly in the composite workflow.

Poem

🐰 I hopped through YAML, neat and spry,
A tag I found beneath the sky,
If comment-pr says yes, I cheer—
I post the tag for all to hear. ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding functionality to comment on PRs with newly created tags.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch comment-pr

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

• JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between ec544a6 and 6aeb5f3.

📒 Files selected for processing (1)

• action.yml (2 hunks)