Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crenshaw-dev/github-executor-plugin

Argo Workflows executor plugin to interact with GitHub
https://github.com/crenshaw-dev/github-executor-plugin

Last synced: 25 days ago
JSON representation

Argo Workflows executor plugin to interact with GitHub

Awesome Lists containing this project

README

        

# github

* Needs: >= v3.3
* Image: crenshawdotdev/github-executor-plugin:latest

[![codecov](https://codecov.io/gh/crenshaw-dev/github-executor-plugin/branch/main/graph/badge.svg?token=MD2ZVGZ5G9)](https://codecov.io/gh/crenshaw-dev/github-executor-plugin)

This is an Argo Workflows executor plugin for interacting with GitHub.

## Example

```yaml
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
generateName: github-example-
spec:
entrypoint: main
templates:
- name: main
plugin:
github:
# Use `issue` to create comments for PRs - the GitHub API considers PRs to be issues.
issue:
comment:
body: "Hello, world!"
number: "1" # PR number, from the
owner: crenshaw-dev
repo: github-executor-plugin
```

## Prerequisites

### Set up a GitHub personal access token

See [GitHub's instructions](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
to set up your token.

Then create a secret using that token.

```bash
# First, copy your token to the clipboard.
pbpaste > token
kubectl create secret generic github-token --from-file=token -n argo
rm token
```

## How to install

Install:

kubectl apply -f github-executor-plugin-configmap.yaml

Uninstall:

kubectl delete cm github-executor-plugin