Rename Buildpackage to PackageDescriptor
#656
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Malax
commented
Aug 24, 2023
edmorley
approved these changes
Aug 24, 2023
Merged
edmorley
added a commit
that referenced
this pull request
Sep 21, 2023
Now that we're treating `libcnb-package` APIs as internal, we're not mentioning `libcnb-package` API changes in the changelog. As such, the changes within #656 can now be described purely in terms of the `libcnb-data` changes, making the changelog entry consistent with other libcnb-data changelog entries in the upcoming release.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While https://buildpacks.io refers to
package.tomlas a "buildpackage" once, it is usually referred to aspackage.tomlwhich is what we also use in our day-to-day conversations. I thinkBuildpackageis a poor name to use within libcnb for the following reasons:BuildpackPackage, it's very easy to confuse the two.I wanted to avoid renaming it to
PackageToml. Even though it might be the first thing that comes to mind as better name, I don't think its a good one. TheTomlsuffix would imply it is TOML data which is not the case for the parsed representation. It can be created via code and never be (de)serialized from or to TOML and the serialised representation is irrelevant when we work with the data in code. We have a similar situation withbuildpack.tomlwhich we namedBuildpackDescriptorfor similar reasons.Thus, I went with
PackageDescriptorto align withBuildpackDescriptor. I think readability of the code already improved after this rename.I have other changes in mind with regard to
PackageDescriptorthat should simplify the code a bunch, but these are out of scope for this PR. This is strictly just a rename.Ref: GUS-W-14007685