Create Ariane repository

[sekhar-isovalent]

Repository Name

ariane

Type

New

Repository URL

cilium/ariane

Proposed Scope

Ecosystem

Motivation for Request

Functionality of the Github App has been diverging for OSS and Enterprise workflows and we wanted to enable OSS Contributors to add the features for ariane.

README

# Ariane

GitHub App for triggering workflows based on trigger phrases found in PR comments, and marking desired workflows successful in merge groups, to be used for Cilium CI.

## How does it work

### Issue Comments

A GitHub App watches comments on pull requests for specific trigger phrases, and manually runs workflows using `workflow_dispatch` events. If configured only allowed team members can trigger the tests. If there are no new changes, no new commit, no force push, issue comment trigger phrases only re-run failed tests.
The triggers themselves, which workflow to run and allowed teams are configured in the repository via `.github/ariane-config.yaml` (basic example available [here](./example/ariane-config.yaml)).

### Merge Group

A GitHub App watches `merge_group` events. When a PR is added to the merge queue the app gets all the required checks for the target branch, and marks the status of the required check as completed with success if its check source is configured as `any source`.

Github workflow builds a docker image and pushes it to Google Artifact Registry (repo-path) is listed in the table above.

## Local development

### One-time setup

- Copy `server-config.yaml.tmpl` to `server-config.yaml` and adjust `address` / `port` to your liking.
- Register a personal GitHub App at https://github.com/settings/apps, which you'll use for development.
- Fill-in `github.app` properties in `server-config.yaml`:
  - `integration_id`: the GitHub App ID
  - `webhook_secret`: a webhook secret of your choice (needs to be set up on the GitHub App).
  - `private_key`: a private key generated from the GitHub App.
- Set up permissions & events for the GitHub App:
  - Repository permissions:
    - Actions: Read and write
    - Administration: Read-only
    - Checks: Read and write
    - Commit statuses: Read and write
    - Contents: Read-only
    - Issues: Read-only
    - Merge queues: Read-only
    - Pull requests: Read and write
  - Organization permissions:
    - Members: Read-only
  - Subscribe to events:
    - Issue comment
    - Merge group
- Install the app to your account and give it access to your test repository (e.g. your fork of Cilium).

### Testing

- Make sure to expose the config's `address` / `port` to the internet (e.g. `ngrok http 8080`).
- Make sure the GitHub App webhook points to `/api/github/hook` on your exposed host (e.g. `https://{ngrok_forward_host}/api/github/hook`).
- Run the app: `go run .`
- In order to register a GitHub workflow, you might need to add `pull_request: {}` to it. This makes the workflow accessible to Ariane. Later on, you can remove the condition, so that it can be started by a trigger phrase.
- Try to comment something in a PR targeting your repository :)

## Production

A GitHub App is  deployed on GCP via App Engine, in order to supervise the main repository `cilium/cilium`.
To update the instances, run the release workflow in GitHub Actions.

License

Apache-2.0 License

Code of Conduct

• I agree to follow Cilium's Code of Conduct

To be filled by a Cilium committer

• README describes the intent of the repository and has usage examples
• Adheres to one of the approved licenses
• Approved new repository is added into the appropriate list in REPOSITORIES.md
• Sync configuration in https://github.com/cilium/team-management

[joestringer]

We've been using Ariane as a tool to enable Cilium organization members to trigger end-to-end tests against their PRs for some time now. I look forward to seeing this repo being open-sourced.

[joestringer]

cc @xmulligan probably the first time we're using this template, not sure if there are specific things to check here. I noticed the link to CNCF license policy is broken so I sent a PR to fix it: #306

[xmulligan]

I'm assuming the repo would be cilium/ariane? Repository URL is empty right now in the template

[sekhar-isovalent]

Yes .. that is correct. it would be cilium/ariane

[xmulligan]

Updated, I think this makes sense to me 👍

[joestringer]

Repository is created: https://github.com/cilium/ariane

[joestringer]

There's a couple of remaining tasks in the issue description before we close this out. I'll keep it open for now to track those things.

[xmulligan]

added in #317