Skip to content

Create GitHub Action for automated doc sync on releases #4

Description

@joshsmithxrm

Summary

Create a GitHub Action that automatically updates ppds-docs when source repos release new versions.

Trigger

When any of these repos create a release:

  • ppds (SDK packages)
  • ppds-alm (workflows/actions)
  • ppds-tools (PowerShell module)

Workflow

  1. Trigger on release tag in source repo
  2. Clone ppds-docs
  3. Run doc generation (could use Ralph Wiggum loop)
  4. Create PR with updated docs
  5. Human reviews and merges

Implementation Options

Option A: Repository Dispatch

Source repo triggers ppds-docs workflow via repository_dispatch.

Option B: Scheduled Sync

ppds-docs runs nightly, checks for new releases, generates if needed.

Option C: Manual with Automation

/generate-docs command that operator runs after releases.

Tasks

  • Decide on trigger mechanism
  • Create workflow in ppds-docs
  • Add repository_dispatch to source repos (if Option A)
  • Test with mock release
  • Document the process

Priority: Low

Manual process works for now. Automate when release cadence increases.

Depends On

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions