Skip to content

docs(action): explicitly mark all optional inputs with required: false#737

Open
kranthipoturaju wants to merge 1 commit into
actions:mainfrom
kranthipoturaju:docs/add-required-false-to-optional-inputs
Open

docs(action): explicitly mark all optional inputs with required: false#737
kranthipoturaju wants to merge 1 commit into
actions:mainfrom
kranthipoturaju:docs/add-required-false-to-optional-inputs

Conversation

@kranthipoturaju
Copy link
Copy Markdown

Summary

Explicitly adds required: false to all optional inputs in action.yml that were missing the declaration. No behavior is changed.

Changes

  • Added required: false to: dotnet-version, dotnet-quality, dotnet-channel, global-json-file, source-url, owner, config-file
  • cache, cache-dependency-path, workloads, and architecture already had required: false and were not modified

Motivation

GitHub Actions treats omitted required as false implicitly, but leaving it unset creates ambiguity for:

  • Consumers reading action.yml to understand the action's contract
  • Tooling (IDEs, linters, schema validators) that introspects action metadata
  • Contributors assessing whether an input must be provided

Impact

  • Users: No behavioral change — all affected inputs were already optional in practice
  • Backward compatibility: Fully preserved; this is a metadata-only change

Testing

No code paths are affected. The action.yml schema change can be validated by running the existing test suite to confirm no regressions.

Related issue:
Change is only associated with documentation and no code changes are made.

Check list:

  • Mark if documentation changes are required.
  • Mark if tests were added or updated to cover the changes.

@kranthipoturaju kranthipoturaju requested a review from a team as a code owner May 25, 2026 13:38
Copilot AI review requested due to automatic review settings May 25, 2026 13:38
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

This PR updates the GitHub Action metadata to explicitly mark several inputs as non-required, improving clarity/consistency for consumers of the action.

Changes:

  • Add required: false to multiple optional inputs in action.yml.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants