Skip to content

Finalize Docs Generator and Implement CI Check #1466

@ricky-undeadcoders

Description

@ricky-undeadcoders

Work has been started on a script that can parse a composite action or reusable workflow, extract the inputs and outputs defined, and then output those inputs/outputs formatted for either a composite action, reusable workflow, or markdown table.

#1454

We should look into putting some extra love into this to do the following:

  1. Write a check that verifies that .github/workflows/docker-build-push-multiarch.yml includes all of the inputs and outputs defined in actions/docker-build-push-image/action.yml.
  2. Write a check that verifies that all actions have their inputs and outputs documented in the associated README.
  3. Write a check to verify that any reusable workflows (in .github/workflows) have their inputs/outputs documented in an associated README.

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