nerdexam
Microsoft

GH-200 · Question #33

What are the most significant advantages of adding documentation while distributing custom actions? (Each answer presents a complete solution. Choose two.)

The correct answer is B. It shares the description of the action to the users. D. It creates a readme.md for the consuming workflow. Documenting custom actions benefits consumers by clearly describing the action's purpose and providing a README that serves as a usage reference.

Create and manage custom actions

Question

What are the most significant advantages of adding documentation while distributing custom actions? (Each answer presents a complete solution. Choose two.)

Options

  • AIt generates auto completion when using the action in a workflow.
  • BIt shares the description of the action to the users.
  • CIt provides an example of the action.
  • DIt creates a readme.md for the consuming workflow.

How the community answered

(39 responses)
  • A
    3% (1)
  • B
    92% (36)
  • C
    5% (2)

Why each option

Documenting custom actions benefits consumers by clearly describing the action's purpose and providing a README that serves as a usage reference.

AIt generates auto completion when using the action in a workflow.

GitHub Actions does not use action documentation files to drive IDE or editor auto-completion; auto-completion in workflow YAML is powered by JSON Schema definitions, not README or description content.

BIt shares the description of the action to the users.Correct

A description in the action's documentation - via action.yml and accompanying prose - communicates the action's purpose, inputs, outputs, and behavior to users without requiring them to read source code, enabling informed adoption.

CIt provides an example of the action.

While including examples is a documentation best practice, it is a component of what good documentation contains rather than a standalone advantage of documentation itself as a distribution artifact.

DIt creates a readme.md for the consuming workflow.Correct

A README.md in the action's repository is the primary documentation artifact visible to consuming workflow authors; it provides usage instructions, configuration details, and context that help users integrate the action correctly.

Concept tested: Best practices for documenting and distributing custom GitHub Actions

Source: https://docs.github.com/en/actions/sharing-automations/creating-actions/about-custom-actions

Topics

#Custom Actions#Documentation#README.md#Action Distribution

Community Discussion

No community discussion yet for this question.

Sign up to join the discussion
Full GH-200 Practice