Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(*): add logic to better determine if a param is internal to Porter #1202

Merged
merged 1 commit into from Aug 21, 2020

Conversation

vdice
Copy link
Member

@vdice vdice commented Aug 6, 2020

What does this change

  • Adds/refactors logic to enable determining if a parameter is internal to Porter across the codebase

What issue does it fix

Now that Porter's list of internal parameters can grow beyond the classic "porter-debug", thanks to the handy parameter sources work, we needed a better way to track these so that they are hidden on porter explain, not eligible for generation in porter parameters generate, etc.

Notes for the reviewer

The approach in this fix is to designate parameters as internal via adding a standardized comment to the $comment field of the parameter's definition schema. This seemed a less fragile route than to try to manage a slice/map in memory. Are there any potential issue(s) with the approach used?

Checklist

  • Unit Tests
  • Documentation
  • Schema (porter.yaml)

If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Signed-off-by: Vaughn Dice <vadice@microsoft.com>
Copy link
Member

@carolynvs carolynvs left a comment

Choose a reason for hiding this comment

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

LGTM

I'll update any of my PRs that add more parameters (like for dependency sources) so that they set the comment as well.

@carolynvs carolynvs merged commit 996d987 into getporter:main Aug 21, 2020
@vdice vdice deleted the fix/internal-params branch August 21, 2020 20:11
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.

None yet

2 participants