Skip to content

Add automation to create docs tracking issues for breaking changes#527

Closed
Copilot wants to merge 8 commits into
mainfrom
copilot/add-breaking-change-automation
Closed

Add automation to create docs tracking issues for breaking changes#527
Copilot wants to merge 8 commits into
mainfrom
copilot/add-breaking-change-automation

Conversation

Copilot AI commented Jan 29, 2026

Copy link
Copy Markdown

Automates creation of documentation tracking issues in dotnet/AspNetCore.Docs when breaking change issues are opened or labeled in this repository.

Implementation

New workflow: .github/workflows/create-docs-issue.yaml

  • Triggers on issues.opened and issues.labeled events with "Breaking change" label
  • Creates issue in docs repo with:
    • Title: [Breaking Change] <original title>
    • Body: Link to source issue, full context
    • Labels: breaking-change, aspnet/Announcements
  • Posts comment on source issue with link to docs issue

Duplicate Prevention

Multi-layer detection to handle race conditions and partial failures:

  • Checks for existing bot comments in source issue
  • Searches docs repo by title before creating
  • Concurrency control keyed on issue number

Error Handling

Separate try-catch blocks for each operation:

  • Comment listing failures → proceed with search
  • Search failures → proceed with creation (fail open to avoid missing docs)
  • Comment posting failures → don't fail workflow (docs issue already created)
  • Permission errors → explicit message about DOCS_ISSUE_TOKEN requirement

Setup Required

Configure DOCS_ISSUE_TOKEN repository secret with repo scope for cross-repository issue creation. Falls back to GITHUB_TOKEN but will fail with clear error message.

Security

Explicit minimal permissions: issues: write, contents: read

Original prompt

Add automation that is triggered when a breaking change issue is opened in this repo. The automation should create an issue in the dotnet/aspnetcore.docs repo that tracks adding documentation for the breaking change.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 7 commits January 29, 2026 17:59
Co-authored-by: danroth27 <1874516+danroth27@users.noreply.github.com>
Co-authored-by: danroth27 <1874516+danroth27@users.noreply.github.com>
Co-authored-by: danroth27 <1874516+danroth27@users.noreply.github.com>
Co-authored-by: danroth27 <1874516+danroth27@users.noreply.github.com>
Co-authored-by: danroth27 <1874516+danroth27@users.noreply.github.com>
Co-authored-by: danroth27 <1874516+danroth27@users.noreply.github.com>
Co-authored-by: danroth27 <1874516+danroth27@users.noreply.github.com>
Copilot AI changed the title [WIP] Add automation for breaking change documentation issue Add automation to create docs tracking issues for breaking changes Jan 29, 2026
Copilot AI requested a review from danroth27 January 29, 2026 18:09
@danroth27 danroth27 closed this Jan 29, 2026
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