distribute-client-workflow.md

Workflow: distribute-client-workflow.yml

Overview

Source file: .github/workflows/distribute-client-workflow.yml

This workflow creates PRs across target repositories to install, update, or remove the client entrypoint workflow.

Prerequisites

• Triggered by changes to:
  • config/**/active-repositories.json (per-org repo lists; example config/obs/active-repositories.json)
  • .github/remote-workflow-template/oblt-aw.yml
• Or manually triggered with workflow_dispatch.

Usage

Main jobs:

• prepare-targets
• create-prs
• summarize

Core behavior:

• computes target operations via scripts/build_target_operations.py
• clones each target repository
• installs or removes target/.github/workflows/oblt-aw.yml
• opens or updates PRs using peter-evans/create-pull-request
• emits consolidated summary via scripts/summarize_pr_results.sh

Input and output contracts

• Target config input accepts either:
  • a list of owner/repo strings
  • an object with repositories: [owner/repo, ...]
• The target builder step exposes:
  • targets (JSON matrix entries with repository and operation)
  • has_targets (true/false)
  • install_count, remove_count, total_count
• Removal operations are computed by comparing current config against the version at BASE_REF.
• PR result artifacts are emitted as repo|op|url lines and consumed by the summarize step.

Configuration

Top-level permissions:

• contents: read

Concurrency:

• group distribute-client-workflow
• cancel-in-progress: false

References

• Operational details: docs/operations/distribute-client-workflow.md
• Client template: docs/workflows/oblt-aw-client-template.md