Skip to content

Call workflow_call to trigger API Docs build in kubricate-docs repo #3

Description

@mildronize

Enhance the kubricate repository to auto-trigger a reusable workflow in kubricate-docs (via workflow_call) whenever there’s a push to the main branch. This will ensure that the documentation site is always up-to-date with the latest code and types.

🎯 Goal

  • Automatically run kubricate-docs/.github/workflows/reusable-docgen.yml whenever kubricate main branch is updated
  • Keep API documentation in sync across releases
  • Avoid manual triggering and ensure developer workflow continuity

🧱 Design Guideline

  • The kubricate-docs repo is public → workflow_call across repos is supported
  • Use job-level uses: directive to call reusable workflow
  • Reference main branch of kubricate-docs
  • No secrets required unless needed later

🧩 Code Section

In kubricate/.github/workflows/trigger-docs.yml:

name: Trigger Docs Update

on:
  push:
    branches:
      - main

jobs:
  call-docs-workflow:
    uses: your-username/kubricate-docs/.github/workflows/reusable-docgen.yml@main

🔁 Replace your-username with your actual GitHub username or org name

✅ Implementation Checklist

  • Create a new workflow in kubricate named trigger-docs.yml
  • Call kubricate-docs/.github/workflows/reusable-docgen.yml using workflow_call
  • Verify that it triggers correctly on every main push
  • (Optional) Add workflow dispatch for manual re-trigger
  • Document this behavior in the README if needed

🧪 Test Plan

  • Push a commit to main in kubricate
  • Confirm kubricate-docs workflow runs via GitHub Actions
  • Validate that the workflow completes and publishes docs as expected

📘 This will automate doc updates and reduce manual syncing effort across repositories.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions