From dad705069bc04384b252a665cb74998e27d3abfd Mon Sep 17 00:00:00 2001 From: Arjun Sreedharan Date: Tue, 6 Jul 2021 09:21:13 -0400 Subject: [PATCH] Remove rfcs contents and add redirect notice (#120) Co-authored-by: Tim Hitchener --- rfcs/0000-template.md | 23 -------------- rfcs/0001-dependency.md | 68 ++--------------------------------------- 2 files changed, 2 insertions(+), 89 deletions(-) delete mode 100644 rfcs/0000-template.md diff --git a/rfcs/0000-template.md b/rfcs/0000-template.md deleted file mode 100644 index ded7a65..0000000 --- a/rfcs/0000-template.md +++ /dev/null @@ -1,23 +0,0 @@ -# {{TITLE: a human-readable title for this RFC!}} - -## Proposal - -{{What changes are you proposing to the buildpack?}} - -## Motivation - -{{Why are we doing this? What pain points does this resolve? What use cases does it support? What is the expected outcome? Use real, concrete examples to make your case!}} - -## Implementation (Optional) - -{{Give a high-level overview of implementation requirements and concerns. Be specific about areas of code that need to change, and what their potential effects are. Discuss which repositories and sub-components will be affected, and what its overall code effect might be.}} - -## Source Material (Optional) - -{{Any source material used in the creation of the RFC should be put here.}} - -## Unresolved Questions and Bikeshedding (Optional) - -{{Write about any arbitrary decisions that need to be made (syntax, colors, formatting, minor UX decisions), and any questions for the proposal that have not been answered.}} - -{{REMOVE THIS SECTION BEFORE RATIFICATION!}} diff --git a/rfcs/0001-dependency.md b/rfcs/0001-dependency.md index c42c875..b51d979 100644 --- a/rfcs/0001-dependency.md +++ b/rfcs/0001-dependency.md @@ -1,66 +1,2 @@ -# Providing a Yarn Dependency - -## Proposal - -In order to enable other buildpacks to execute commands using the `yarn` CLI, -this buildpack will make the `yarn` executable available on the `$PATH`. - -## Motivation - -[`Yarn`](https://yarnpkg.com/) is a popular and common package manager for -Javascript dependencies. Many Javascript developers will want to execute `yarn` -commands as part of their `build` or `launch` process. Even more directly, -there are already existing -[buildpacks](https://github.com/paketo-buildpacks/yarn-install) that will want -to execute `yarn` commands as part of their `build` process. - -In an effort to maintain modularity and simplicity, this buildpack will only -install the executable and leave all other aspects of using `yarn` to other -buildpacks. - -## Implementation - -### Detect Phase - -During detection, the buildpack will provide a `yarn` dependency in its -buildplan. This will enable other buildpacks to require `yarn` be made -available in the `build` and `launch` phases. - -Requiring the `yarn` dependency can be accomplished by writing a buildplan -during the detect phase that includes the following requirement: - -```toml -[[requires]] - name = "yarn" -``` - -### Build Phase - -Given that `yarn` is required as part of the buildplan, the buildpack will -create a layer and install the `yarn` executable into that layer, making it -available to subsequent buildpacks or the launcher on the `$PATH` as part of -the [Buildpack -API](https://github.com/buildpacks/spec/blob/main/buildpack.md#layer-paths). - -### Specifying dependency inclusion during lifecycle phases - -The buildpack will provide an API that allows other buildpacks to signal what -phases the `yarn` executable should be made available in. This is accomplished -by including extra metadata when requiring the `yarn` dependency in the detect -phase. For example, to require that the `yarn` dependency be made available -during both `build` and `launch`, specify a buildplan that looks like the -following: - -```toml -[[requires]] - name = "yarn" - - [requires.metadata] - build = true - launch = true -``` - -This will ensure that the layer that includes the `yarn` executable will be -made available to subsequent buildpacks during the `build` phase. It also -ensures that the layer will ultimately be included as part of the built -application image, and thus available during the application `launch` phase. +This page has moved. The new location is: +https://github.com/paketo-buildpacks/rfcs/blob/main/text/nodejs/0006-yarn-dependency.md