Skip to content

Rename reusable-workflow-notification to workflow-failure-issue and add consumer docs#69

Open
trask wants to merge 5 commits into
open-telemetry:mainfrom
trask:workflow-failure-issue
Open

Rename reusable-workflow-notification to workflow-failure-issue and add consumer docs#69
trask wants to merge 5 commits into
open-telemetry:mainfrom
trask:workflow-failure-issue

Conversation

@trask

@trask trask commented Jul 10, 2026

Copy link
Copy Markdown
Member

Completes the migration of the reusable-workflow-notification workflow into shared-workflows as a documented, catalog-listed shared workflow.

  • Renames .github/workflows/reusable-workflow-notification.yml to .github/workflows/workflow-failure-issue.yml (dropping the redundant reusable- prefix, since every shared workflow here is reusable) and sets the display name to Workflow failure issue.
  • Adds a consumer-facing workflow-failure-issue/README.md documenting what the workflow does and the uses: snippet, including the required issues: write permission and if: always() guidance.
  • Adds a catalog row to the main README.
  • Adds CODEOWNERS entries for the workflow and its docs folder.
  • Updates this repo's own caller in pull-request-dashboard.yml to the new filename.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-issue reusable workflow and lists it in the repository’s workflow catalog.
  • Renames/standardizes the reusable workflow entrypoint to .github/workflows/workflow-failure-issue.yml and 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.

Comment thread workflow-failure-issue/README.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Comment thread workflow-failure-issue/README.md Outdated
Comment thread README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 explicit issues: write.

Comment thread workflow-failure-issue/README.md Outdated
Comment thread .github/workflows/pull-request-dashboard.yml
@trask

trask commented Jul 10, 2026

Copy link
Copy Markdown
Member Author

Also addressed the low-confidence suggestion on workflow-failure-issue.yml: set the workflow-level permissions to {} (relying on the job's explicit issues: write) to match the repo's reusable-workflow pattern in first-time-pr.yml.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_name input 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 a workflow_call reusable workflow, GITHUB_WORKFLOW/github.workflow is 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 a workflow_name string input (caller passes ${{ github.workflow }}) and using that value in the gh issue list/create/comment commands.

Comment thread workflow-failure-issue/README.md
Comment thread workflow-failure-issue/README.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Comment thread workflow-failure-issue/README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

@trask trask marked this pull request as ready for review July 10, 2026 03:43
@trask trask requested a review from a team as a code owner July 10, 2026 03:43
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