Skip to content

Add reusable KDoc deploy template to centralize deployment workflow management#1

Draft
Copilot wants to merge 3 commits into
doc-indexfrom
copilot/create-reusable-template
Draft

Add reusable KDoc deploy template to centralize deployment workflow management#1
Copilot wants to merge 3 commits into
doc-indexfrom
copilot/create-reusable-template

Conversation

Copilot AI commented Jun 27, 2026

Copy link
Copy Markdown

Managing 22 independent kdoc-deploy/* branch workflows means every deployment logic change requires 22 separate updates, and the lack of unified concurrency control causes race conditions when multiple branches push to gh-pages simultaneously.

Changes

Added: .github/workflows/deploy-kdoc-template.yml

Reusable workflow_call template on doc-index (default branch) with:

  • Global concurrency: group: deploy-to-gh-pages, cancel-in-progress: false — all deployments queue instead of racing
  • Single source of truth for checkout + peaceiris/actions-gh-pages@v3 logic

Each kdoc-deploy/* branch workflow reduces to:

name: Deploy KDoc Pages
on:
  push:
    branches: 'kdoc-deploy/component-kook'
jobs:
  deploy:
    uses: simple-robot-library/simbot3-api-docs/.github/workflows/deploy-kdoc-template.yml@doc-index
    with:
      destination_dir: components/kook
    secrets:
      PUSH_TOKEN: ${{ secrets.PUSH_TOKEN }}

Removed: .github/workflows/deploy-main-v5-kdoc.yml from doc-index

This file was misplaced on doc-index by a prior agent session. The canonical workflow (with concurrency) already exists on kdoc-deploy/main-v5.

Remaining Work (requires repo owner)

The 22 kdoc-deploy/* branches are protected — direct pushes are rejected by repository rules. All 22 per-branch workflow updates are prepared but cannot be applied by this agent. The owner (ForteScarlet) needs to update each branch's existing workflow file to the minimal caller format above. Branch-to-destination_dir mappings:

Branch File destination_dir
kdoc-deploy/main deploy-main-kdoc.yml main
kdoc-deploy/main-v4 deploy-main-v4-kdoc.yml main-v4
kdoc-deploy/main-v5 deploy-main-v5-kdoc.yml main-v5
kdoc-deploy/component-kook deploy-kook-kdoc.yml components/kook
kdoc-deploy/component-kook-v3 deploy-kook-kdoc.yml components/kook-v3
kdoc-deploy/component-mirai deploy-mirai-kdoc.yml components/mirai
kdoc-deploy/component-miyoushe-villa deploy-villa-kdoc.yml components/miyoushe-villa
kdoc-deploy/component-onebot deploy-ob-kdoc.yml components/onebot
kdoc-deploy/component-qq-guild deploy-qg-kdoc.yml components/qq-guild
kdoc-deploy/component-qq-guild-v3 deploy-qg-kdoc.yml components/qq-guild-v3
kdoc-deploy/component-telegram deploy-tg-kdoc.yml components/telegram
kdoc-deploy/component-tencent-guild deploy-tcg-kdoc.yml components/tencent-guild
kdoc-deploy/snapshots/main deploy-main-snapshot-kdoc.yml snapshots/main
kdoc-deploy/snapshots/main-v4 deploy-main-v4-snapshot-kdoc.yml snapshots/main-v4
kdoc-deploy/snapshots/component-kook deploy-kook-snapshot-kdoc.yml snapshots/components/kook
kdoc-deploy/snapshots/component-kook-v3 deploy-kook-snapshot-kdoc.yml snapshots/components/kook-v3
kdoc-deploy/snapshots/component-mirai deploy-mirai-snapshot-kdoc.yml snapshots/components/mirai
kdoc-deploy/snapshots/component-miyoushe-villa deploy-villa-snapshot-kdoc.yml snapshots/components/miyoushe-villa
kdoc-deploy/snapshots/component-onebot deploy-ob-kdoc.yml snapshots/components/onebot
kdoc-deploy/snapshots/component-qq-guild deploy-qg-snapshot-kdoc.yml snapshots/components/qq-guild
kdoc-deploy/snapshots/component-qq-guild-v3 deploy-qg-snapshot-kdoc.yml snapshots/components/qq-guild-v3
kdoc-deploy/snapshots/component-telegram deploy-tg-sapshot-kdoc.yml snapshots/components/telegram

kdoc-deploy/component-qq-guild-v4 and kdoc-deploy/snapshots/component-qq-guild-v4 have no workflows and are left unchanged.

@vercel

vercel Bot commented Jun 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
simbot3-api-docs Ready Ready Preview, Comment Jun 27, 2026 5:23am

Copilot AI changed the title [WIP] Create reusable template for API Docs deployment Add reusable KDoc deploy template to centralize deployment workflow management Jun 27, 2026
Copilot AI requested a review from ForteScarlet June 27, 2026 05:24
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