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.

Sign up for GitHub

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

Jump to bottom

Porter explain command displays custom section data when output is JSON or YAML #2767

Merged
merged 11 commits into from
May 31, 2023
Merged

Porter explain command displays custom section data when output is JSON or YAML #2767

merged 11 commits into from
May 31, 2023

Conversation

tompaana
Copy link
Contributor

What does this change

Adds the user-defined custom section data to the output of porter explain command when the output format is JSON or YAML:

  • Implements the feature
  • Updates unit tests
  • Updates documentation

What issue does it fix

Closes #2764

Checklist

  • Did you write tests?
  • Did you write documentation?
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Reviewer Checklist

  • Comment with /azp run test-porter-release if a magefile or build script was modified
  • Comment with /azp run porter-integration if it's a non-trivial PR

@tompaana
Adds custom section to output
27c28f0 
Signed-off-by: Tomi Paananen <[email protected]>
@tompaana
Restores mixins in table output
4c8d52e 
Signed-off-by: Tomi Paananen <[email protected]>
@tompaana
Removes commented out line
1e257a4 
Signed-off-by: Tomi Paananen <[email protected]>
@tompaana
Minor fix
cabf233 
Signed-off-by: Tomi Paananen <[email protected]>
@tompaana
Done it the proper way this time I think
a3ca334 
Signed-off-by: Tomi Paananen <[email protected]>
@tompaana
Modifies test data to support custom output
1436630 
Signed-off-by: Tomi Paananen <[email protected]>
@tompaana
Fixes order in expected output as it is sorted
da76dd1 
Signed-off-by: Tomi Paananen <[email protected]>
@tompaana
Updates porter explain documentation
28ae88f 
Signed-off-by: Tomi Paananen <[email protected]>
@tompaana
Adding my name to the list of contributors
6f11c15 
Signed-off-by: Tomi Paananen <[email protected]>
@tompaana tompaana force-pushed the explain-displays-custom-section branch from 68bb253 to 6f11c15 Compare May 23, 2023 10:31
sgettys
sgettys reviewed May 23, 2023
View reviewed changes
pkg/porter/explain.go Outdated Show resolved Hide resolved
sgettys
sgettys reviewed May 23, 2023
View reviewed changes
pkg/porter/explain.go Outdated Show resolved Hide resolved
@tompaana
Fixes based in review
c3167a2 
Signed-off-by: Tomi Paananen <[email protected]>
@tompaana
Grammar fix
c3a51f1 
Signed-off-by: Tomi Paananen <[email protected]>
@schristoff
Copy link
Member

/azp run porter-integration

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@schristoff schristoff merged commit 9dfd04f into getporter:main May 31, 2023
15 checks passed
@tompaana tompaana deleted the explain-displays-custom-section branch June 1, 2023 06:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arschles arschles arschles approved these changes

@sgettys sgettys sgettys approved these changes

@schristoff schristoff Awaiting requested review from schristoff schristoff is a code owner

@bdegeeter bdegeeter Awaiting requested review from bdegeeter bdegeeter is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Porter explain to display custom section when output is JSON
4 participants
@tompaana @schristoff @arschles @sgettys