Skip to content

Commit

Permalink
Update README.md with more clarity on use of this repository.
Browse files Browse the repository at this point in the history
  • Loading branch information
jromero committed Jul 12, 2022
1 parent f9246de commit af04160
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 59 deletions.
38 changes: 38 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
## Samples

Samples require some bootstraping hence there are two scripts to assist in executing the samples.

##### Prerequisites

- `kubectl`
- ... with configured context
- [Tekton Pipelines][tekton-install]
- Docker Registry
- ... learn how to use a [local registry](./DEVELOPMENT.md#docker-registry)
- ... other registries may require additional [auth configuration][tekton-docker-auth]

[tekton-install]: https://github.com/tektoncd/pipeline/blob/master/docs/install.md#installing-tekton-pipelines-on-kubernetes
[tekton-docker-auth]: https://github.com/tektoncd/pipeline/blob/master/docs/auth.md#configuring-authentication-for-docker

##### Run

```
./scripts/sample-run.sh <path/to/sample.yaml> <image-name>
```

Additional options (using `tkn`):

- To rerun a pipeline with the same parameters:
```
tkn pipeline start buildpacks --last --showlog
```
- To rerun a pipeline while overriding last paramters (ie. `TRUST_BUILDER`):
```
tkn pipeline start buildpacks --last --showlog -p TRUST_BUILDER=false
```

##### Cleanup

```
./scripts/sample-cleanup.sh <path/to/sample.yaml>
```

## Linting

Expand Down
66 changes: 7 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,78 +1,26 @@
# Tekton Integration

The purpose of this repository is to provide the means for testing and developing the integration between [Tekton][tekton] and Cloud Native Buildpack's [Lifecycle][lifecycle].
> The purpose of this repository is to provide tooling to help test and release the integration between [Tekton][tekton] and Cloud Native Buildpack's [Lifecycle][lifecycle].
>
> **The actual pipeline and tasks are maintained on the official [tektoncd/catalog][catalog]**. :smile_cat:
## Pipeline

| Pipeline | Source | Description
|--- |--- |---
| buildpacks | [next (dev)](pipeline/buildpacks) · catalog (TBD) | Builds an application image from source stored in `git`.


## Tasks

| Task | Source | Description
|--- |--- |---
| buildpacks | [next (dev)](task/buildpacks) · [catalog][task-buildpacks] | Improved performance by executing entire build in the least amount of containers.
| buildpacks-phases | [next (dev)](task/buildpacks-phases) · [catalog][task-buildpacks-phases] | Improved security by isolating build phases to individual containers.

[catalog]: https://github.com/tektoncd/catalog
[lifecycle]: https://buildpacks.io/docs/concepts/components/lifecycle/
[task-buildpacks]: https://github.com/tektoncd/catalog/tree/master/task/buildpacks
[task-buildpacks-phases]: https://github.com/tektoncd/catalog/tree/master/task/buildpacks-phases
[tekton]: https://tekton.dev/


## Samples

There are a few samples through out this repo. Most require some bootstraping hence there are two scripts to assist in executing the samples.

##### Prerequisites

- `kubectl`
- ... with configured context
- [Tekton Pipelines][tekton-install]
- Docker Registry
- ... learn how to use a [local registry](./DEVELOPMENT.md#docker-registry)
- ... other registries may require additional [auth configuration][tekton-docker-auth]

[tekton-install]: https://github.com/tektoncd/pipeline/blob/master/docs/install.md#installing-tekton-pipelines-on-kubernetes
[tekton-docker-auth]: https://github.com/tektoncd/pipeline/blob/master/docs/auth.md#configuring-authentication-for-docker

##### Run

```
./scripts/sample-run.sh <path/to/sample.yaml> <image-name>
```

Additional options (using `tkn`):

- To rerun a pipeline with the same parameters:
```
tkn pipeline start buildpacks --last --showlog
```
- To rerun a pipeline while overriding last paramters (ie. `TRUST_BUILDER`):
```
tkn pipeline start buildpacks --last --showlog -p TRUST_BUILDER=false
```

##### Cleanup

```
./scripts/sample-cleanup.sh <path/to/sample.yaml>
```

## Support

The [Buildpacks Community](http://buildpacks.io/community/) is always here to help.

We can be found in our [discussion board][discussion-board] or [slack][slack] (`#tekton`).
We can be found in our [discussion board][discussion-board] or [slack][slack] (`#buildpacks-tekton`).

[discussion-board]: https://github.com/buildpacks/community/discussions
[slack]: https://slack.buildpacks.io
[slack]: https://slack.cncf.io/

## Contributing

We contributions.
We :heart: contributions.

- [CONTRIBUTING](https://github.com/buildpacks/.github/blob/main/CONTRIBUTING.md) - Learn what's necessary to start contributing.
- [DEVELOPMENT](DEVELOPMENT.md) - Get details to help you during development within this specific repo.

0 comments on commit af04160

Please sign in to comment.