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

Remove name field from CNAB dependency representation in bundle.json #2660

Merged
merged 1 commit into from
Mar 28, 2023

Conversation

carolynvs
Copy link
Member

What does this change

The name field for a dependency is not in the spec because CNAB represents a dependency as a map entry, keyed by name. We use a name internally just to make things easier while working with dependency entries but they shouldn't be written out with a name field.

I have updated how we serialize the dependency structs so that even when name is populated, we don't write it to bundle.json

What issue does it fix

Fixes #2659

Notes for the reviewer

N/A

Checklist

  • Did you write tests? Updated existing testdata
  • 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

The name field for a dependency is not in the spec because CNAB represents a dependency as a map entry, keyed by name. We use a name internally just to make things easier while working with dependency entries but they shouldn't be written out with a name field.

I have updated how we serialize the dependency structs so that even when name is populated, we don't write it to bundle.json.

Signed-off-by: Carolyn Van Slyck <[email protected]>
@carolynvs carolynvs marked this pull request as ready for review March 27, 2023 23:58
@carolynvs carolynvs merged commit c2625f6 into getporter:main Mar 28, 2023
@carolynvs carolynvs deleted the depsv1-remove-name branch March 28, 2023 16:38
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.

bundle.json should not have a name field for required dependencies
2 participants