Skip to content

Improve action input descriptions and reorder consistently#1074

Merged
smorimoto merged 1 commit intomasterfrom
improve-action-input-descriptions
Mar 21, 2026
Merged

Improve action input descriptions and reorder consistently#1074
smorimoto merged 1 commit intomasterfrom
improve-action-input-descriptions

Conversation

@smorimoto
Copy link
Copy Markdown
Member

@smorimoto smorimoto commented Mar 21, 2026

Summary

  • Enriched all action input descriptions in action.yml with practical details — accepted values, default behaviour, related inputs, and platform-specific notes — to match the level of detail already present in windows-environment and windows-compiler.
  • Reordered inputs consistently across action.yml, README.md, and constants.ts by user relevance: core settings first, then opam behaviour, caching, Windows-specific, and advanced/internal.
  • Updated the README inputs table to reflect the improved descriptions and corrected stale default values (e.g. cache-prefix was listed as v1 but is actually v3).

Test plan

  • Verify the action runs correctly on all platforms (no behavioural changes, documentation only).
  • Confirm the README table renders correctly on GitHub.

The input descriptions in action.yml were minimal and inconsistent —
some (windows-environment, windows-compiler) had detailed multi-line
descriptions whilst others had only a single terse sentence. This
enriches all descriptions with practical details (accepted values,
default behaviour, related inputs) and reorders inputs consistently
across action.yml, README.md, and constants.ts by user relevance:
core settings first, then opam, caching, Windows, and advanced.
@smorimoto smorimoto added the documentation Improvements or additions to documentation label Mar 21, 2026
@smorimoto smorimoto merged commit 6abb143 into master Mar 21, 2026
24 checks passed
@smorimoto smorimoto deleted the improve-action-input-descriptions branch March 21, 2026 18:56
@smorimoto smorimoto mentioned this pull request Mar 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant