Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve onboarding of Tekton maintenance #38

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
100 changes: 0 additions & 100 deletions pipeline/buildpacks/0.1/README.md

This file was deleted.

56 changes: 0 additions & 56 deletions pipeline/buildpacks/0.1/README.tpl.md

This file was deleted.

Loading