Skip to content

Commit

Permalink
Improve the README in master branch
Browse files Browse the repository at this point in the history 
Signed-off-by: ishani2412 <[email protected]>
  • Loading branch information
@tekton-robot
ishani2412 authored and tekton-robot committed Jul 6, 2020
1 parent a312a82 commit 7a481c5
Show file tree
Hide file tree
Showing 36 changed files with 46 additions and 46 deletions.
2 changes: 1 addition & 1 deletion argocd/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This task syncs (deploys) an [Argo CD](https://argoproj.github.io/argo-cd/) appl
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/argocd/argocd.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/argocd/argocd.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion aws-cli/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ All aws cli commands can be found [here](https://docs.aws.amazon.com/cli/latest/
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/aws-cli/aws-cli.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/aws-cli/aws-cli.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion azure-cli/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This task performs operations on Microsoft Azure resources using `az`.
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/azure-cli/azure_cli.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/azure-cli/azure_cli.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion buildah/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ to assemble a container image, then pushes that image to a container registry.
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/buildah/buildah.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/buildah/buildah.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion buildid/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Given a base version, this task generates a unique build id by appending the bas
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/buildid/task.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/buildid/task.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion buildkit-daemonless/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This `buildkit-daemonless` Task is similar to [`buildkit`](../buildkit) but does
## Install

```console
$ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/buildkit-daemonless/buildkit-daemonless.yaml
$ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/buildkit-daemonless/buildkit-daemonless.yaml
task.tekton.dev/buildkit-daemonless created
```

Expand Down
2 changes: 1 addition & 1 deletion buildpacks/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Cloud Native Buildpacks website describes v3 buildpacks as:
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/buildpacks/buildpacks-v3.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/buildpacks/buildpacks-v3.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).
Expand Down
4 changes: 2 additions & 2 deletions conftest/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ your Tekton pipelines. Conftest is a tool for testing configuration files using
In order to use Conftest with Tekton you need to first install the task.

```console
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/conftest/conftest.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/conftest/conftest.yaml
```

Conftest also has a Helm plugin, which redners the Helm chart before applying the policy. For that task use:

```console
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/conftest/helm-conftest.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/conftest/helm-conftest.yaml
```


Expand Down
2 changes: 1 addition & 1 deletion curl/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This task performs curl operation to transfer data from internet .
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/curl/curl.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/curl/curl.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion gcloud/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This task performs operations on Google Cloud Platform resources using `gcloud`.
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/gcloud/gcloud.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/gcloud/gcloud.yaml
```

## Parameters
Expand Down
6 changes: 3 additions & 3 deletions github/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ informations about the CI statuses or a direct link to the full log.
### Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/github/set_status.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/github/set_status.yaml
```

### Parameters
Expand Down Expand Up @@ -82,7 +82,7 @@ issue.
### Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/github/add_comment.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/github/add_comment.yaml
```
### Parameters
Expand Down Expand Up @@ -132,7 +132,7 @@ issue.
### Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/github/close_issue.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/github/close_issue.yaml
```

### Parameters
Expand Down
2 changes: 1 addition & 1 deletion gitlab/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ stringData:
### Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/gitlab/add-labels.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/gitlab/add-labels.yaml
```

### Parameters
Expand Down
4 changes: 2 additions & 2 deletions gke-deploy/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This Task deploys an application to a Google Kubernetes Engine cluster using [`g
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/gke-deploy/gke-deploy.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/gke-deploy/gke-deploy.yaml
```

## Parameters
Expand Down Expand Up @@ -84,7 +84,7 @@ This Pipeline builds, pushes, and deploys your application to a Google Kubernete
## Install the Pipeline

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/gke-deploy/build-push-gke-deploy.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/gke-deploy/build-push-gke-deploy.yaml
```
## Workspaces
Expand Down
6 changes: 3 additions & 3 deletions golang/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ These Tasks are Golang task to build, test and validate Go projects.
## Install the tasks

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/golang/lint.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/golang/build.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/golang/tests.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/golang/lint.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/golang/build.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/golang/tests.yaml
```

## `golangci-lint`
Expand Down
2 changes: 1 addition & 1 deletion jib-gradle/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Jib works with [Gradle](https://github.com/GoogleContainerTools/jib/tree/master/
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/jib-gradle/jib-gradle.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/jib-gradle/jib-gradle.yaml
```


Expand Down
2 changes: 1 addition & 1 deletion jib-maven/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Jib works with [Maven](https://github.com/GoogleContainerTools/jib/tree/master/j
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/jib-maven/jib-maven.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/jib-maven/jib-maven.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion kaniko/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ makes it a perfect tool to be part of Tekton.
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/kaniko/kaniko.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/kaniko/kaniko.yaml
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions kn/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This Task performs operations on Knative resources (services, revisions, routes)
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/kn/kn.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/kn/kn.yaml
```

## Parameters
Expand Down Expand Up @@ -41,7 +41,7 @@ with permission to manage Knative resources.
To create a `ServiceAccount` with these permissions, you can run:

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/kn/kn-deployer.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/kn/kn-deployer.yaml
```

### Running the Task
Expand Down
2 changes: 1 addition & 1 deletion knctl/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ only the `deploy` subcommand as of today.
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/knctl/knctl-deploy.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/knctl/knctl-deploy.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion kubeconfig-creator/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This task provides users variety of ways to authenticate:
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/kubeconfig-creator/kubeconfig-creator.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/kubeconfig-creator/kubeconfig-creator.yaml
```

## Workspace
Expand Down
2 changes: 1 addition & 1 deletion kubeval/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ your Tekton pipelines. Kubeval is a tool used for validating Kubernetes configur
In order to use Kubeval with Tekton you need to first install the task.

```console
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/kubeval/kubeval.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/kubeval/kubeval.yaml
```

## Usage
Expand Down
2 changes: 1 addition & 1 deletion mail/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This task sends a simple email to receivers via SMTP server
## Install the Task and create a secret

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/mail/sendmail.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/mail/sendmail.yaml
```

Create a secret that has the SMTP server information
Expand Down
2 changes: 1 addition & 1 deletion makisu/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ kubectl --namespace default create secret generic docker-registry-config --from-
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/makisu/makisu.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/makisu/makisu.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion maven/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This Task can be used to run a Maven build.
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/maven/maven.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/maven/maven.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion openshift-client-python/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The set of possible scripts can be found in the docs [here](https://github.com/o

## Install the Task
```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/openshift-client-python/openshift-client-python.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/openshift-client-python/openshift-client-python.yaml
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions openshift-client/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ There are two tasks provided for the OpenShift CLI which differ only in their ta

Install `openshift-client` task:
```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/openshift-client/openshift-client-task.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/openshift-client/openshift-client-task.yaml
```

Install `openshift-client-kubecfg` task:
```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/openshift-client/openshift-client-kubecfg-task.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/openshift-client/openshift-client-kubecfg-task.yaml
```

## Parameters `openshift-client`
Expand Down
4 changes: 2 additions & 2 deletions openshift-provision/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The following task is used to create the cluster.
### **Install the Task**

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/openshift-provision/openshift-cluster-create.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/openshift-provision/openshift-cluster-create.yaml
```

### **Parameters**
Expand Down Expand Up @@ -55,7 +55,7 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/open
### **Install the Task**

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/openshift-provision/openshift-cluster-destroy.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/openshift-provision/openshift-cluster-destroy.yaml
```

### **Workspaces**
Expand Down
2 changes: 1 addition & 1 deletion replace-tokens/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The above same can be done for the `YAML` file also.
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/replace-tokens/replace-tokens.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/replace-tokens/replace-tokens.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion s2i/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ source code.
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/s2i/s2i.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/s2i/s2i.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion skopeo/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This task uses image from [this](https://github.com/tektoncd/plumbing/tree/maste
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/skopeo/skopeo.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/skopeo/skopeo.yaml
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions slackmessage/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Follow instructions [here](https://api.slack.com/messaging/webhooks) to generate
## Install the Task and create a secret

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/slackmessage/send-to-webhook-slack.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/slackmessage/send-to-webhook-slack.yaml
```

Create a secret that has the generated webhook URL
Expand Down Expand Up @@ -66,7 +66,7 @@ The app must join the channel before the message posted by this task run. (invit
## Install the Task and create a secret

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/slackmessage/send-to-channel-slack.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/slackmessage/send-to-channel-slack.yaml
```

Create a secret that has the OAuth token of the bot app.
Expand Down
2 changes: 1 addition & 1 deletion sonarqube/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ For creating your own `sonar-project.properties` please follow the guide [here](
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/sonarqube/sonarqube.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/sonarqube/sonarqube.yaml
```

## Pre-requisite
Expand Down
2 changes: 1 addition & 1 deletion telegrammessage/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Create a bot as decribed over [here](https://core.telegram.org/bots).
## Install the Task and create a secret

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/telegrammessage/send-to-telegram.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/telegrammessage/send-to-telegram.yaml
```

Create a secret that has bot token.
Expand Down
2 changes: 1 addition & 1 deletion terraform-cli/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

Install `terraform-cli` task for kubernetes 1.6+:
```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/terraform-cli/terraform-cli-task-kube1.6.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/terraform-cli/terraform-cli-task-kube1.6.yaml
```
This task currently works only on kubernetes 1.6+ support for a task that works on older versions of kubernetes will be added soon.

Expand Down
2 changes: 1 addition & 1 deletion tkn/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This task performs operations on Tekton resources using
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/tkn/tkn.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/tkn/tkn.yaml
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion wget/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This task uses wget to download files from the internet to a workspace .
## Install the Task

```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/v1beta1/wget/wget.yaml
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/wget/wget.yaml
```

## Parameters
Expand Down

0 comments on commit 7a481c5

Please sign in to comment.