Skip to content

Commit

Permalink
Rename buildpacks-v3 to buildpacks
Browse files Browse the repository at this point in the history
* V3 is confusing, and isn't relevant to users

Signed-off-by: David Freilich <[email protected]>
  • Loading branch information
dfreilich committed Jul 13, 2020
1 parent 5dabea1 commit e96eeb8
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 14 deletions.
File renamed without changes.
18 changes: 8 additions & 10 deletions task/buildpacks-v3/0.1/README.md → task/buildpacks/0.1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This build template builds source into a container image using [Cloud Native
Buildpacks](https://buildpacks.io).

The Cloud Native Buildpacks website describes v3 buildpacks as:
The Cloud Native Buildpacks website describes buildpacks as:

> ... pluggable, modular tools that translate source code into container-ready
> artifacts such as OCI images. They replace Dockerfiles in the app development
Expand All @@ -15,21 +15,19 @@ The Cloud Native Buildpacks website describes v3 buildpacks as:
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/task/buildpacks-v3/0.1/buildpacks-v3.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/task/buildpacks/0.1/buildpacks.yaml
```

> **NOTE:** This task is currently only compatible with Tekton **v0.11.0** and above, and CNB Platform API 0.3 (lifecycle v0.7.0 and above). For previous Platform API versions, [see below](#previous-platform-api-versions).
## Parameters

* **`BUILDER_IMAGE`**: The image on which builds will run. (must include v3 lifecycle and compatible buildpacks; _required_)
* **`BUILDER_IMAGE`**: The image on which builds will run. (must include lifecycle and compatible buildpacks; _required_)

* **`CACHE`**: The name of the persistent app cache volume. (_default:_ an empty
directory -- effectively no cache)
* **`CACHE`**: The name of the persistent app cache volume. (_default:_ an empty directory -- effectively no cache)

* **`PLATFORM_DIR`**: A directory containing platform provided configuration, such as environment variables.
Files of the format `/platform/env/MY_VAR` with content `my-value` will be translated by the lifecycle into
environment variables provided to buildpacks. For more information, see the [buildpacks spec](https://github.com/buildpacks/spec/blob/master/buildpack.md#provided-by-the-platform). (_default:_ an empty directory)
Files of the format `/platform/env/MY_VAR` with content `my-value` will be translated by the lifecycle into environment variables provided to buildpacks. For more information, see the [buildpacks spec](https://github.com/buildpacks/spec/blob/master/buildpack.md#provided-by-the-platform). (_default:_ an empty directory)

* **`USER_ID`**: The user ID of the builder image user, as a string value. (_default:_ `"1000"`)

Expand All @@ -50,7 +48,7 @@ The `source` workspace holds the source to build. See `SOURCE_SUBPATH` above if

## Usage

This `TaskRun` will use the `buildpacks-v3` task to build the source code, then publish a container image.
This `TaskRun` will use the `buildpacks` task to build the source code, then publish a container image.

```
apiVersion: tekton.dev/v1beta1
Expand All @@ -59,7 +57,7 @@ metadata:
name: example-run
spec:
taskRef:
name: buildpacks-v3
name: buildpacks
podTemplate:
volumes:
# Uncomment the lines below to use an existing cache
Expand Down Expand Up @@ -97,7 +95,7 @@ spec:

### Example builders

Cloud Foundry:
Paketo:
- `gcr.io/paketo-buildpacks/builder:base` &rrar; Ubuntu bionic base image with buildpacks for Java, NodeJS and Golang
- `gcr.io/paketo-buildpacks/builder:full-cf` &rarr; cflinuxfs3 base image with buildpacks for Java, .NET, NodeJS, Golang, PHP, HTTPD and NGINX
- `gcr.io/paketo-buildpacks/builder:tiny` &rarr; Tiny base image (bionic build image, distroless run image) with buildpacks for Golang
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
apiVersion: tekton.dev/v1beta1
kind: Task
metadata:
name: buildpacks-v3
name: buildpacks
labels:
app.kubernetes.io/version: "0.1"
annotations:
Expand All @@ -22,7 +22,7 @@ spec:
params:
- name: BUILDER_IMAGE
description: The image on which builds will run (must include v3 lifecycle and compatible buildpacks).
description: The image on which builds will run (must include lifecycle and compatible buildpacks).
- name: CACHE
description: The name of the persistent app cache volume.
default: empty-dir
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ spec:
value: ""
- name: deleteExisting
value: "true"
- name: buildpacks-v3
- name: buildpacks
taskRef:
name: buildpacks-v3
name: buildpacks
runAfter:
- fetch-repository
workspaces:
Expand Down

0 comments on commit e96eeb8

Please sign in to comment.