1
0
mirror of https://github.com/tektoncd/catalog.git synced 2024-11-24 06:15:46 +00:00
catalog/task/github-app-token/0.1
Quan Zhang e294e1246b [TEP-0110] Update Tekton Catalog installation instructions
Prior to this change, the installation instructions directly use the resource urls in the Catalog repo, which results in tight coupling between the organization and how users fetch resources (as described in TEP-0110). This commit updates the installation guide to install Tekton Catalog resources via Tekton Hub Api: https://github.com/tektoncd/hub/pull/539

This change decouples the Tekton Catalog organization from resouces resolution, which enables Tekton Catalog reorganization.
2022-08-16 16:25:52 +01:00
..
samples Add Github APP token task 2020-09-29 12:55:51 +01:00
Dockerfile Add Github APP token task 2020-09-29 12:55:51 +01:00
github-app-token.yaml Add linux/amd64 platform annotation to the rest of the tasks 2021-10-29 17:08:38 +01:00
README.md [TEP-0110] Update Tekton Catalog installation instructions 2022-08-16 16:25:52 +01:00

GitHub app token

A task to get a user token from a github application

Workspaces

  • secrets: A workspace containing the private key of the application.

Secret

This GitHub applications needs a private key to sign your request with JWT.

This example can be referred to create the secret

Refer this guide for setting up AWS Credentials and Region.

Params

  • installation_id: The GitHub app installation ID eg: 123456
  • application_id: The GitHub application ID. e.g: 123456
  • private_key_path: The path to the key inside the secret workspace, default: private.key
  • token_expiration_minutes:: The time to expirations of the token in minutes default: 10

Install the Task

kubectl apply -f https://api.hub.tekton.dev/v1/resource/tekton/task/github-app-token/0.1/raw

Platforms

The Task can be run on linux/amd64 platform.

Usage

After creating the task with the parameters, you should have the token as result in the task which can be used in your pipeline to do github operations from the app as the target user.

See this taskrun example on how to start the task directly.