Rename reusable-workflow-notification to workflow-failure-issue and add consumer docs#69
Rename reusable-workflow-notification to workflow-failure-issue and add consumer docs#69trask wants to merge 5 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Completes the migration of the former reusable-workflow-notification reusable workflow into the shared-workflows catalog under the new name Workflow failure issue, adds consumer documentation, and updates internal references and ownership metadata.
Changes:
- Introduces consumer-facing documentation for the
workflow-failure-issuereusable workflow and lists it in the repository’s workflow catalog. - Renames/standardizes the reusable workflow entrypoint to
.github/workflows/workflow-failure-issue.ymland updates this repo’s caller to use the new path. - Adds/updates CODEOWNERS coverage for the workflow and its docs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
workflow-failure-issue/README.md |
Adds consumer documentation and a usage snippet for the reusable workflow. |
README.md |
Adds the workflow to the shared-workflows catalog table. |
.github/workflows/workflow-failure-issue.yml |
Renames the reusable workflow display name and job key to the new convention. |
.github/workflows/pull-request-dashboard.yml |
Updates the internal caller to use the renamed reusable workflow file. |
.github/CODEOWNERS |
Adds ownership rules for the workflow and its documentation folder. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
.github/workflows/workflow-failure-issue.yml:13
- This reusable workflow sets top-level
permissions: contents: read, but the only job overrides permissions and doesn’t use repository contents. To match the repo’s established reusable-workflow pattern (e.g.,.github/workflows/first-time-pr.yml:18) and minimize token scope, set workflow-level permissions to{}and rely on the job’s explicitissues: write.
|
Also addressed the low-confidence suggestion on |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (2)
.github/workflows/pull-request-dashboard.yml:235
- If the reusable workflow starts using a
workflow_nameinput to name/search issues by the caller workflow, this caller should pass it (typically${{ github.workflow }}) so the hourly failure issue is attributed to the correct workflow.
uses: ./.github/workflows/workflow-failure-issue.yml
with:
# A superseded per-repo publish is cancelled (publish-dashboard uses
# cancel-in-progress: true), so count cancelled as success here to avoid
# opening noisy failure issues. Genuine failures still surface because
.github/workflows/workflow-failure-issue.yml:2
- This workflow’s issue search/title/body uses
$GITHUB_WORKFLOW(later in the script) as the monitored workflow identifier. In aworkflow_callreusable workflow,GITHUB_WORKFLOW/github.workflowis the called workflow name (Workflow failure issue), not the caller’s workflow name, so tracking issues won’t clearly identify which monitored workflow failed (and won’t match the README’s<workflow name>behavior). Consider adding aworkflow_namestring input (caller passes${{ github.workflow }}) and using that value in thegh issue list/create/commentcommands.
Completes the migration of the
reusable-workflow-notificationworkflow into shared-workflows as a documented, catalog-listed shared workflow..github/workflows/reusable-workflow-notification.ymlto.github/workflows/workflow-failure-issue.yml(dropping the redundantreusable-prefix, since every shared workflow here is reusable) and sets the display name toWorkflow failure issue.workflow-failure-issue/README.mddocumenting what the workflow does and theuses:snippet, including the requiredissues: writepermission andif: always()guidance.CODEOWNERSentries for the workflow and its docs folder.pull-request-dashboard.ymlto the new filename.