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

Update Paketo's suggested builders #2200

Open
edmorley opened this issue Jul 3, 2024 · 1 comment
Open

Update Paketo's suggested builders #2200

edmorley opened this issue Jul 3, 2024 · 1 comment
Labels
help wanted Need some extra hands to get this done. status/discussion-needed Issue or PR that requires in-depth discussion. type/enhancement Issue that requests a new feature or improvement.
Milestone

Comments

@edmorley
Copy link
Contributor

edmorley commented Jul 3, 2024

Description

Currently the Pack CLI's known builders list contains the following suggested Paketo builders:

{
Vendor: "Paketo Buildpacks",
Image: "paketobuildpacks/builder-jammy-base",
DefaultDescription: "Small base image with buildpacks for Java, Node.js, Golang, .NET Core, Python & Ruby",
Suggested: true,
Trusted: true,
},
{
Vendor: "Paketo Buildpacks",
Image: "paketobuildpacks/builder-jammy-full",
DefaultDescription: "Larger base image with buildpacks for Java, Node.js, Golang, .NET Core, Python, Ruby, & PHP",
Suggested: true,
Trusted: true,
},
{
Vendor: "Paketo Buildpacks",
Image: "paketobuildpacks/builder-jammy-tiny",
DefaultDescription: "Tiny base image (jammy build image, distroless run image) with buildpacks for Golang & Java",
Suggested: true,
Trusted: true,
},
{
Vendor: "Paketo Buildpacks",
Image: "paketobuildpacks/builder-jammy-buildpackless-static",
DefaultDescription: "Static base image (jammy build image, distroless run image) suitable for static binaries like Go or Rust",
Suggested: true,
Trusted: true,
},

The descriptions for the builders defined in this repo (which are used when offline and Pack CLI can't pull from the registry) currently don't match the descriptions set on the builders themselves:
https://github.com/paketo-buildpacks/builder-jammy-base/blob/a967f70684506e873bc7c8b23a74f46d51d3c526/builder.toml#L1
https://github.com/paketo-buildpacks/builder-jammy-full/blob/406b1cd36df58012e4700050f42e718bda76d572/builder.toml#L1
https://github.com/paketo-buildpacks/builder-jammy-tiny/blob/bf9411eb6aa3ecf208976bf3154d90f536a4bd74/builder.toml#L1

Also, I'm a bit confused why paketobuildpacks/builder-jammy-buildpackless-static is a Pack suggested builder, when that builder isn't listed on the Paketro builders page?
https://paketo.io/docs/reference/builders-reference/

Lastly, I wonder whether having 4 suggested builders might be slightly too many, given Heroku and Google only have one suggested builder each? I think it does make sense to include the full vs base vs tiny builders, but perhaps the "buildpackless" builder variant shouldn't be a suggested builder? (If only because it's not really suitable for beginners, given it won't work without also specifying external buildpacks.)

Proposed solution

  • Update the builder descriptions in this repo to match the descriptions set in the builder's own builder.toml metadata
  • Demote paketobuildpacks/builder-jammy-buildpackless-static to being only a trusted builder and not also a suggested builder. (Or if that builder is deprecated, given it's not listed on https://paketo.io/docs/reference/builders-reference/ , then perhaps remove it from known-builders entirely?)
  • Add the other builders on https://paketo.io/docs/reference/builders-reference/ (eg the other buildpackless builders) as "trusted but not suggested" builders
@edmorley edmorley added status/triage Issue or PR that requires contributor attention. type/enhancement Issue that requests a new feature or improvement. labels Jul 3, 2024
@natalieparellano
Copy link
Member

cc @ForestEckhardt as Paketo maintainer for thoughts

@natalieparellano natalieparellano added status/discussion-needed Issue or PR that requires in-depth discussion. status/ready Issue ready to be worked on. and removed status/triage Issue or PR that requires contributor attention. status/ready Issue ready to be worked on. labels Jul 3, 2024
@natalieparellano natalieparellano added this to the 0.36.0 milestone Jul 3, 2024
@natalieparellano natalieparellano modified the milestones: 0.36.0, 0.37.0 Nov 12, 2024
@natalieparellano natalieparellano added the help wanted Need some extra hands to get this done. label Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Need some extra hands to get this done. status/discussion-needed Issue or PR that requires in-depth discussion. type/enhancement Issue that requests a new feature or improvement.
Projects
None yet
Development

No branches or pull requests

2 participants