Skip to content

[Code Quality] Document runtimes configuration in frontmatter reference #14086

Description

@github-actions

Description

The runtimes: configuration is fully defined in the schema and presumably implemented in the codebase, but is completely undocumented in the user-facing frontmatter reference. Users cannot customize runtime environments without discovering this feature through schema exploration.

Suggested Changes

Add a new section to docs/src/content/docs/reference/frontmatter.md documenting the runtimes: configuration:

  1. Configuration format:

    runtimes:
      node:
        version: "22"
      python:
        version: "3.12"
        action-repo: "actions/setup-python"
        action-version: "v5"
  2. Supported runtimes:

    • Node.js (node)
    • Python (python)
    • Go (go)
    • Others as documented in schema
  3. Use cases:

    • Override default runtime versions
    • Pin to specific setup action versions
    • Use custom setup actions

Files Affected

  • docs/src/content/docs/reference/frontmatter.md (add new section)

Success Criteria

  • Documentation section added with clear examples
  • At least 2 common runtime configurations shown
  • Custom action configuration explained
  • Practical use cases documented
  • No other files need changes

Source

Extracted from Schema Consistency Audit discussion #14066

Original finding:

runtimes: Configuration

  • Schema: Fully defined with version, action-repo, and action-version ✓
  • Implementation: Presumably handled in runtime setup code ✓
  • Documentation: Missing from main frontmatter documentation
  • Impact: Advanced users cannot customize runtime environments

Priority

Medium - Enables advanced customization but not required for basic workflows

AI generated by Discussion Task Miner - Code Quality Improvement Agent

  • expires on Feb 7, 2026, 9:12 AM UTC

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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions