Skip to content

v1 Unit 5: Documentation and v1.0.0 #54

Description

@mairas

Part of the shared-workflows v1 plan (tracking issue: issue 49).

Goal: README and examples describe only the v1 interface; v1.0.0 and v1 exist.

Requirements: R3

Dependencies: Units 2–4 verified on canaries

Files:

  • Modify: README.md (rewrite per-workflow sections and input tables; migration guide from @main)
  • Delete: examples/cockpit-apt/
  • Modify: examples/docs-repo/.github/workflows/translation-status.yml (pin @v1)
  • Tag-only repositories use the npm example's pr.yml and main.yml; no separate example

Approach: Tables generated by reading the workflow inputs, not copied from the old README. Migration guide maps each legacy input to its v1 replacement.

Test expectation: none -- documentation; lint from Unit 1 covers example YAML.

Verification: Every input in every workflow_call appears in the README with the YAML default.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions