Skip to content

Conversation

AustinAbro321
Copy link
Contributor

Description

This removes most of the hints from the package yaml. The only one that is kept is the hint that gives the variable values as this hint could be relied on, and it doesn't take up extra newlines. Otherwise, the feedback I've gotten from users is that the hints don't add much value. As we've seen the general user base of Zarf shift towards more automated deploys, keeping there is less of a case for keeping these in. Additionally there is currently a bug with how the hints display variables.

Related Issue

Fixes #2974

visual changes

before / currently

image

after

image

Checklist before merging

Signed-off-by: Austin Abro <austinabro321@gmail.com>
@AustinAbro321 AustinAbro321 requested review from a team as code owners September 5, 2025 14:28
Copy link

netlify bot commented Sep 5, 2025

Deploy Preview for zarf-docs canceled.

Name Link
🔨 Latest commit ca58e04
🔍 Latest deploy log https://app.netlify.com/projects/zarf-docs/deploys/68baf3a8579ae30008a418d8

Copy link

codecov bot commented Sep 5, 2025

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/cmd/package.go 0.00% 1 Missing ⚠️
Files with missing lines Coverage Δ
src/cmd/package.go 38.40% <0.00%> (+0.19%) ⬆️

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@mkcp mkcp left a comment

Choose a reason for hiding this comment

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

LGTM

@AustinAbro321 AustinAbro321 added this pull request to the merge queue Sep 5, 2025
Merged via the queue into main with commit b337191 Sep 5, 2025
27 checks passed
@AustinAbro321 AustinAbro321 deleted the remove-yaml-hints branch September 5, 2025 15:29
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.

Remove hints from printed yaml
2 participants