diff --git a/README.md b/README.md index 93d2ba8ea4..1dbb3c047b 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ Shipwright supports any tool that can build container images in Kubernetes clust ## Try It! -* We assume you already have a Kubernetes cluster (v1.18+). If you don't, you can use [KinD](https://kind.sigs.k8s.io), which you can install by running [`./hack/install-kind.sh`](./hack/install-kind.sh). +* We assume you already have a Kubernetes cluster (v1.17+). If you don't, you can use [KinD](https://kind.sigs.k8s.io), which you can install by running [`./hack/install-kind.sh`](./hack/install-kind.sh). -* We also require a Tekton installation (v1.19+). To install the latest version, run: +* We also require a Tekton installation (v0.19+). To install the latest version, run: ```bash $ kubectl apply --filename https://storage.googleapis.com/tekton-releases/pipeline/previous/v0.20.1/release.yaml @@ -124,7 +124,7 @@ Shipwright supports any tool that can build container images in Kubernetes clust Depending on your source code, you might want to build it differently with Shipwright. -To find out more on what's the best strategy or what else can Shipwright do for you, please visit our [tutorial](./docs/tutorials/tutorial.md)! +To find out more on what's the best strategy or what else can Shipwright do for you, please visit our [tutorial](./docs/tutorials/README.md)! ## More information @@ -143,13 +143,13 @@ To find out more on what's the best strategy or what else can Shipwright do for | Dependency | Supported versions | | -------------------------------------| ---------------------------- | | [Kubernetes](https://kubernetes.io/) | v1.17.\*, v1.18.\*, v1.19.\* | -| [Tekton](https://tekton.dev) | v0.21.0 | +| [Tekton](https://tekton.dev) | v0.19.0, v0.20.\*, v0.21.0 | ## Want to get involved? ### Community meetings -We host weekly meetings for contributors, maintainers and anyone interested in the project. The weekly meetings take place on Mondays at 2pm UTC. +We host weekly meetings for contributors, maintainers and anyone interested in the project. The weekly meetings take place on Mondays at 1pm UTC. * Meeting [minutes](https://github.com/shipwright-io/build/issues?q=is%3Aissue+label%3Acommunity+label%3Ameeting+is%3Aopen) * Public calendar [invite](https://calendar.google.com/calendar/u/1?cid=Y19iMWVndjc3anUyczJkbWNkM2R1ZnAxazhuNEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t) diff --git a/docs/tutorials/tutorial.md b/docs/tutorials/README.md similarity index 91% rename from docs/tutorials/tutorial.md rename to docs/tutorials/README.md index 15cd12bf9c..4b78406378 100644 --- a/docs/tutorials/tutorial.md +++ b/docs/tutorials/README.md @@ -32,19 +32,19 @@ Shipwright ships with a set of strategies that are available across the cluster. The default installation includes these [buildstrategies](/docs/buildstrategies.md): -* [Source-to-Image](docs/buildstrategies.md#source-to-image) * [Buildpacks-v3](docs/buildstrategies.md#buildpacks-v3) -* [Buildah](docs/buildstrategies.md#buildah) * [Kaniko](docs/buildstrategies.md#kaniko) +* [Source-to-Image](docs/buildstrategies.md#source-to-image) +* [Buildah](docs/buildstrategies.md#buildah) * [ko](docs/buildstrategies.md#ko) For more information about strategies see the related [docs](/docs/buildstrategies.md). ## Examples -### [Example with Kaniko](/docs/tutorials/building_with_kaniko.md) +* [Example with Kaniko](/docs/tutorials/building_with_kaniko.md) -### [Example with Paketo](/docs/tutorials/building_with_paketo.md) +* [Example with Paketo](/docs/tutorials/building_with_paketo.md) Depending on your source code you might want to try a specific example. The following table serves as a guide to help you understand which strategy to choose: @@ -55,6 +55,8 @@ strategy to choose: | A go app | [shipwright-io/sample-go](https://github.com/shipwright-io/sample-go) | `/source-build` | Dockerfile-less | Paketo,Heroku | | A ruby app | [shipwright-io/sample-ruby](https://github.com/shipwright-io/sample-ruby) | `/source-build` | Dockerfile-less | Paketo,Heroku | | A java app with a Dockerfile | [hipwright-io/sample-jave](https://github.com/shipwright-io/sample-java) | `/docker-build` | Dockerfile-based | Kaniko, Buildah | -| Shipwright/Build | [shipwright-io/build](https://github.com/shipwright-io/build) | `/cmd/manager` | Dockerfile-less | Paketo,Heroku, Ko | +| Shipwright/Build | [shipwright-io/build](https://github.com/shipwright-io/build) | `/cmd/manager` | Dockerfile-less | ko | _Note_: `ContextDir` is the path under the repository where the source code is located. + +_Note_: `Buildpacks-v3` support is provided via Paketo and Heroku. Paketo is our default tool for Buildpacks.