Skip to content

docs(buildpacks): clarify how to use private buildpacks with multi-buildpack#3574

Merged
yanjost merged 2 commits intomasterfrom
docs/private-buildpacks-multi
Mar 11, 2026
Merged

docs(buildpacks): clarify how to use private buildpacks with multi-buildpack#3574
yanjost merged 2 commits intomasterfrom
docs/private-buildpacks-multi

Conversation

@yanjost
Copy link
Copy Markdown
Contributor

@yanjost yanjost commented Feb 26, 2026

Why

The current multi-buildpack guide explains .buildpacks syntax and ordering, but it is not explicit about the private buildpack workflow.
This can lead users to try HTTPS private URLs while using ssh-private-key-buildpack, which fails.

What changed

In src/_posts/platform/deployment/buildpacks/2000-01-01-multi.md, this PR adds a minimal section:

  • "Can I Use Private Buildpacks?"
  • Explicit recommendation to add ssh-private-key-buildpack first
  • Concrete .buildpacks example with private git@... URLs and branch syntax
  • Note recommending SSH URLs for private repositories when using the SSH key buildpack

Scope

  • Docs only
  • No product/runtime behavior changes

Copy link
Copy Markdown
Contributor

@benjaminach benjaminach left a comment

Choose a reason for hiding this comment

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

I find the format of this page a bit unusual, but since your addition respects the general format of the page... LGTM.

Copy link
Copy Markdown
Contributor

@Frzk Frzk left a comment

Choose a reason for hiding this comment

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

praise: thanks, I didn't know it was possible to do this!

comment: same as @benjaminach -- Looks like another page that would benefit from a rewrite 😫

suggestion: maybe it would be nice to also update (or even remove) the paragraph here: https://doc.scalingo.com/platform/deployment/buildpacks/custom#private-buildpack?

Comment thread src/_posts/platform/deployment/buildpacks/2000-01-01-multi.md Outdated
Co-authored-by: François <francois+github@kubler.org>
@yanjost
Copy link
Copy Markdown
Contributor Author

yanjost commented Mar 5, 2026

@Frzk what do you suggest we do with the other "Private buildpacks" section ?

@Frzk
Copy link
Copy Markdown
Contributor

Frzk commented Mar 5, 2026

I'm suggesting to remove it:

  • it promotes security by obfuscation ;
  • it's much more secure to use the ssh-private-key-buildpack in the multi-buildpack to access a custom private buildpack
  • I'm not sure it's even working

@benjaminach: WDYT?

@benjaminach
Copy link
Copy Markdown
Contributor

I will follow your proposal.

Perhaps, we could promote the .buildpacks file as the standard approach for both custom and multi-buildpack configurations?

Custom buildpacks configured through the env var could instead be documented as a quick workaround to override the buildpack, rather than a clean long-term solution, since configuration should ideally live in the application code 🤔

@yanjost yanjost merged commit 2bedc1f into master Mar 11, 2026
3 checks passed
@yanjost yanjost deleted the docs/private-buildpacks-multi branch March 11, 2026 10:43
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.

3 participants