Skip to content

ci: integrate sync-docs workflow#388

Merged
neilime merged 1 commit into
mainfrom
copilot/implement-sync-documentation-workflow
Oct 28, 2025
Merged

ci: integrate sync-docs workflow#388
neilime merged 1 commit into
mainfrom
copilot/implement-sync-documentation-workflow

Conversation

Copilot AI commented Oct 28, 2025

Copy link
Copy Markdown
Contributor

Implements workflow to sync repository documentation to the public-docs portal per sync-docs-dispatcher.md.

Changes

  • .github/workflows/__main-ci.yml - Added sync-docs job that directly calls hoverkraft-tech/public-docs/.github/workflows/sync-docs-dispatcher.yml@18facec04f2945f4d66d510e8a06568497b73c54 (v0.1.0)
    • Runs after CI job completes
    • Skips on scheduled runs (consistent with release job)
    • Syncs markdown documentation files:
      • actions/**/README.md - All README files in actions directory
      • .github/workflows/*.md - Workflow documentation files
      • README.md - Root README file
    • Uses PUBLIC_DOCS_TOKEN secret with repository_dispatch permissions
    • Pinned to version 0.1.0 for stability and security
  • SYNC_DOCS_IMPROVEMENTS.md - Implementation guide for future Copilot agents

Integration

The sync-docs job is now part of the main CI workflow and automatically syncs documentation to the public-docs portal on every push to main (excluding scheduled runs).

Implementation Guide

SYNC_DOCS_IMPROVEMENTS.md provides concise, actionable instructions for implementing the sync-docs workflow in other repositories, including:

  • Quick-start implementation example
  • Key points for proper integration (workflow type, version pinning, path configuration)
  • YAML formatting best practices
  • Recommendations for upstream documentation improvements

The guide is optimized for future Copilot agents to quickly understand and implement the workflow correctly.

Original prompt

Implmeent the sync documentation workflow, following these instructions: https://github.com/hoverkraft-tech/public-docs/blob/main/.github/workflows/sync-docs-dispatcher.md

At the end you will propose some documentaiton imlprovment from what was missing or needs to be improved in sync-docs-dispatcher.md for the next one who will read this doc


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Implement sync documentation workflow Add sync-docs reusable workflow Oct 28, 2025
Copilot AI requested a review from neilime October 28, 2025 11:30

@neilime neilime left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot handle feedbacks

Comment thread .github/workflows/sync-docs.yml Outdated

Copilot AI commented Oct 28, 2025

Copy link
Copy Markdown
Contributor Author

@copilot handle feedbacks

Feedback addressed. Integrated sync-docs directly into __main-ci.yml instead of creating a separate reusable workflow. (7787460)

Copilot AI changed the title Add sync-docs reusable workflow Integrate sync-docs into main CI workflow Oct 28, 2025
Copilot AI requested a review from neilime October 28, 2025 15:05

@neilime neilime left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot handle feedbacks

Comment thread .github/workflows/__main-ci.yml Outdated

Copilot AI commented Oct 28, 2025

Copy link
Copy Markdown
Contributor Author

@copilot handle feedbacks

Feedback addressed. Updated sync-docs paths to be more specific and only sync markdown documentation files. (32d2aa7)

Copilot AI requested a review from neilime October 28, 2025 15:17
@neilime neilime marked this pull request as ready for review October 28, 2025 15:20

@neilime neilime left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot handle feedbacks, then update SYNC_DOCS_IMPROVEMENTS.md accordingly with concise, usefull instructions to be handle by copilot agent in the future

Comment thread .github/workflows/__main-ci.yml Outdated

Copilot AI commented Oct 28, 2025

Copy link
Copy Markdown
Contributor Author

@copilot handle feedbacks, then update SYNC_DOCS_IMPROVEMENTS.md accordingly with concise, usefull instructions to be handle by copilot agent in the future

Done. Updated workflow to version 0.1.0 and refactored SYNC_DOCS_IMPROVEMENTS.md to be concise and actionable for future Copilot agents. The guide now includes quick-start implementation example and key learnings. (2c93c54)

Copilot AI requested a review from neilime October 28, 2025 15:42
@neilime neilime changed the title Integrate sync-docs into main CI workflow ci: integrate sync-docs workflow Oct 28, 2025
@neilime neilime force-pushed the copilot/implement-sync-documentation-workflow branch from 2c93c54 to f36c7a3 Compare October 28, 2025 16:55
@neilime neilime force-pushed the copilot/implement-sync-documentation-workflow branch from f36c7a3 to e7fb74c Compare October 28, 2025 16:56
@neilime neilime enabled auto-merge October 28, 2025 16:59
@neilime neilime disabled auto-merge October 28, 2025 16:59
@neilime neilime merged commit 881e2c1 into main Oct 28, 2025
27 checks passed
@neilime neilime deleted the copilot/implement-sync-documentation-workflow branch October 28, 2025 16:59
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