Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.56 KB

0030-links-for-buildpacks.md

File metadata and controls

71 lines (50 loc) · 2.56 KB
Raw

Meta

  • Name: Buildpack homepage
  • Start Date: 1-23-2020
  • Status: Implemented
  • CNB Pull Request: rfcs#55
  • CNB Issue: (leave blank)
  • Supersedes: (put "N/A" unless this replaces an existing RFC, then link to that RFC)

Summary

This RFC suggest a mechanism where buildpacks can provide arbitrary links in their configuration: point to a homepage. These links are intended to contain documentation, point to github repos, point users to readmes, etc. but should not prescribe a format.

Motivation

At the moment the origin and provenance of a buildpack are sort of a black box. Users have asked where to find information about the repos for buildpacks so they can file issues, but we would also like a method to allow buildpacks to surface their configuration options or anything else their authors think pertinent. Without prescribing a format for this need broadly, we should have a mechanism for buildpack authors to include a link they can pass to their users.

What it is

Add an additional, optional, field to buildpack.toml - homepage. Expand the io.buildpacks.buildpackage.metadata to include homepage if it is provided in buildpack.toml.

How it Works

This link would be available for platforms to display, for example pack inspect-builder BUILDER would dump these links like so:

Buildpacks:
  ID                                                VERSION         HOMEPAGE
  org.cloudfoundry.azureapplicationinsights         v1.1.9          https://github.com/cloudfoundry/azure-application-insights-cnb

Inclusion of this link would allow buildpack authors to provide a pointer to arbitrary information for their consumers.

A buildpack.toml for the above buildpack would look like:

api = "0.2"

[buildpack]
id = "org.cloudfoundry.azureapplicationinsights"
version = "1.1.9"
homepage = "https://github.com/cloudfoundry/azure-application-insights-cnb" # <- New optional field

[[stacks]]
....snip....

Drawbacks

Too generic a pointer?

Alternatives

  • A docs field containing markdown.

Prior Art

Unresolved Questions