Skip to content

636: Created help comment command#660

Merged
az2924 merged 2 commits intomainfrom
636
Jan 15, 2026
Merged

636: Created help comment command#660
az2924 merged 2 commits intomainfrom
636

Conversation

@az2924
Copy link
Copy Markdown
Collaborator

@az2924 az2924 commented Jan 15, 2026

636

Description of changes

  • Created help-command.yml to display helpful wiki commands when PR is first opened

Checklist before review

  • I have done a thorough self-review of the PR
  • Copilot has reviewed my latest changes, and all comments have been fixed and/or closed.
  • If I have made database changes, I have made sure I followed all the db repo rules listed in the wiki here. (check if no db changes)
  • All tests have passed
  • I have successfully deployed this PR to staging
  • I have done manual QA in both dev (and staging if possible) and attached screenshots below.

Screenshots

Dev

Screenshot 2026-01-15 at 11 19 04 AM

Staging

Not needed, as AC was to see if help command shows up when PR is opened

@github-actions
Copy link
Copy Markdown
Contributor

Available PR Commands

  • /ai - Triggers all AI review commands at once
  • /review - AI review of the PR changes
  • /describe - AI-powered description of the PR
  • /improve - AI-powered suggestions
  • /deploy - Deploy to staging

See: https://github.com/tahminator/codebloom/wiki/CI-Commands

@az2924
Copy link
Copy Markdown
Collaborator Author

az2924 commented Jan 15, 2026

/deploy

@github-actions
Copy link
Copy Markdown
Contributor

Title

636: Created help comment command


PR Type

Enhancement, Documentation


Description

  • Add workflow to auto-comment PR help

  • Post available CI command list on open

  • Link to wiki for command details


Diagram Walkthrough

flowchart LR
  pr["PR Opened"]
  wf["GitHub Actions workflow"]
  msg["Post help comment with commands"]
  wiki["Wiki: CI-Commands"]

  pr -- "trigger" --> wf
  wf -- "send message" --> msg
  msg -- "link" --> wiki
Loading

File Walkthrough

Relevant files
Enhancement
help-command.yml
New workflow to auto-comment PR help                                         

.github/workflows/help-command.yml

  • Add PR-opened workflow.
  • Grant repo and PR write permissions.
  • Invoke composite action .github/composite/send-message.
  • Post formatted help message with CI commands and wiki link.
+35/-0   

@github-actions
Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Event Scope

Workflow only triggers on the 'opened' action and will not post help for reopened or draft->ready-for-review transitions; confirm this matches the exact AC and desired behavior.

on:
  pull_request:
    types: [opened]
Permissions

Workflow grants 'contents', 'issues', and 'pull-requests' write; verify least-privilege—'pull-requests: write' should suffice if only commenting on PRs.

permissions:
  contents: write
  issues: write
  pull-requests: write
Commands List

Ensure the commands listed exactly match the wiki (names, availability, and syntax) and add any missing ones; otherwise help may mislead users.

message: |
  ### Available PR Commands

  - `/ai` - Triggers all AI review commands at once
  - `/review` - AI review of the PR changes
  - `/describe` - AI-powered description of the PR
  - `/improve` - AI-powered suggestions
  - `/deploy` - Deploy to staging

  See: https://github.com/tahminator/codebloom/wiki/CI-Commands

@github-actions
Copy link
Copy Markdown
Contributor

The command to deploy to staging for the commit e83516b has been triggered. View action run

@az2924
Copy link
Copy Markdown
Collaborator Author

az2924 commented Jan 15, 2026

/deploy

@github-actions
Copy link
Copy Markdown
Contributor

Staging deployment was cancelled for commit e83516b

View run

@github-actions
Copy link
Copy Markdown
Contributor

The command to deploy to staging for the commit fffa2d2 has been triggered. View action run

@github-actions
Copy link
Copy Markdown
Contributor

Overall Project 75.66% 🍏

There is no coverage information present for the Files changed

@github-actions
Copy link
Copy Markdown
Contributor

Staging deployment succeeded for commit fffa2d2

View run

@az2924 az2924 merged commit 13dbd90 into main Jan 15, 2026
30 of 34 checks passed
@az2924 az2924 deleted the 636 branch January 15, 2026 18:44
@github-actions
Copy link
Copy Markdown
Contributor

Overall Project 75.5% 🍏

There is no coverage information present for the Files changed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants