Skip to content

Add GitHub Actions workflow to auto-create documentation issues from drasi-platform PR merges#149

Closed
Copilot wants to merge 1 commit into
fix-linksfrom
copilot/fix-27ba8a22-1fe1-40df-b645-a2d0696206d7
Closed

Add GitHub Actions workflow to auto-create documentation issues from drasi-platform PR merges#149
Copilot wants to merge 1 commit into
fix-linksfrom
copilot/fix-27ba8a22-1fe1-40df-b645-a2d0696206d7

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Sep 10, 2025

This PR implements automation to automatically create documentation issues in the docs repository whenever a pull request is merged in the drasi-project/drasi-platform repository.

What's Added

🤖 Auto-Issue Creation Workflow

  • .github/workflows/auto-create-docs-issue.yaml - GitHub Actions workflow that triggers on repository_dispatch events
  • Creates properly formatted issues with comprehensive PR details including:
    • PR number, title, author, and merge information
    • Direct links to the merged PR
    • List of potentially affected files
    • Actionable checklist for documentation updates
    • Automatic labeling with documentation, auto-generated, and platform-update

📚 Complete Documentation & Setup Guide

  • .github/workflows/README.md - Comprehensive documentation including:
    • Step-by-step setup instructions for the drasi-platform repository
    • Required GitHub token configuration
    • Manual testing commands using GitHub CLI
    • Example of generated issue format

How It Works

  1. Trigger: When a PR is merged in drasi-platform, it sends a repository_dispatch event to this docs repo
  2. Automation: The workflow automatically creates a structured issue with all relevant PR details
  3. Action: Documentation maintainers can review and update docs based on the generated issue

Example Generated Issue

📝 Update documentation for merged PR #123

## Documentation Update Required
A pull request has been merged in the drasi-platform repository that may require documentation updates.

**Merged PR Details:**
- **PR Number:** #123
- **Title:** Add new reactive query feature
- **Author:** @developer
- **Merged by:** @maintainer
- **PR URL:** https://github.com/drasi-project/drasi-platform/pull/123

**Action Required:**
- [ ] Review the changes in the merged PR
- [ ] Identify documentation that needs to be updated
- [ ] Update relevant documentation pages
- [ ] Test any code examples or instructions

Next Steps

To complete the setup, the drasi-project/drasi-platform repository needs to:

  1. Add the trigger workflow as documented in the README
  2. Configure a DOCS_REPO_TOKEN secret with repository dispatch permissions

This automation ensures no platform changes go undocumented and provides a structured workflow for keeping documentation in sync with code changes.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@NValsan NValsan closed this Sep 10, 2025
Copilot AI changed the title [WIP] auto-generate issue in the docs PR if a PR is merged in drasi-project/drasi-platform repo Add GitHub Actions workflow to auto-create documentation issues from drasi-platform PR merges Sep 10, 2025
Copilot AI requested a review from NValsan September 10, 2025 16:33
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