Skip to content

Conversation

NoaheCampbell
Copy link
Contributor

Description, Motivation and Context

This PR adds two new UX-focused subcommands to Preflight and aligns the v1beta3 authoring model with v1beta2, plus richer documentation output.

  • Added preflight template:

    • Renders templated specs with multiple --values files and Helm-style --set overrides where the last one added will take priority over any conflicts.
    • Uses Helm engine for .Values-based templates.
    • Outputs fully resolved YAML with conditionals removed.
  • Added preflight docs:

    • Accepts one or more specs; renders each with provided values and concatenates enabled analyzers’ docStrings to Markdown.
    • Multiple --values files, --set overrides, and -o output supported.
    • Markdown formatting: Title: lines → headings; sections separated by blank lines.
    • Normalizes values maps pre-merge to avoid type errors with strvals.
  • v1beta3 spec shape decisions:

    • Align structure to v1beta2: spec.analyzers: [...].
    • Optional docString at the analyzer level for docs extraction.
    • Helm templating with .Values.; feature modularity via analyzer-level {{ if .Values. }} guards.
    • Added docString in order for vendors to give end customers explanations for requirements in an attempt to reduce friction points

Checklist

  • New and existing tests pass locally with introduced changes.
  • Tests for the changes have been added (for bug fixes / features)
  • The commit message(s) are informative and highlight any breaking changes
  • Any documentation required has been added/updated. For changes to https://troubleshoot.sh/ create a PR here

Does this PR introduce a breaking change?

  • Yes
  • No

@NoaheCampbell NoaheCampbell requested a review from a team as a code owner September 10, 2025 22:19
@NoaheCampbell NoaheCampbell added the type::feature New feature or request label Sep 10, 2025
@NoaheCampbell NoaheCampbell requested a review from a team as a code owner September 10, 2025 22:19
cursor[bot]

This comment was marked as outdated.

@NoaheCampbell NoaheCampbell changed the base branch from main to v1beta3 September 10, 2025 22:22
Copy link

@bennyyang11 bennyyang11 left a comment

Choose a reason for hiding this comment

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

Just some clarification questions.

Copy link

@bennyyang11 bennyyang11 left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@NoaheCampbell NoaheCampbell merged commit acc1aad into v1beta3 Sep 16, 2025
22 checks passed
@NoaheCampbell NoaheCampbell deleted the preflight-docs-and-template-subcommands branch September 16, 2025 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants