Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpmcb/prow-github-actions
Slash commands, jobs, and chat-ops for Github actions inspired by Kubernetes Prow ⚓️
https://github.com/jpmcb/prow-github-actions
chat-ops github-actions prow
Last synced: about 2 months ago
JSON representation
Slash commands, jobs, and chat-ops for Github actions inspired by Kubernetes Prow ⚓️
- Host: GitHub
- URL: https://github.com/jpmcb/prow-github-actions
- Owner: jpmcb
- License: mit
- Created: 2020-04-11T20:58:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-17T12:13:21.000Z (about 1 year ago)
- Last Synced: 2024-05-12T15:34:27.762Z (4 months ago)
- Topics: chat-ops, github-actions, prow
- Language: TypeScript
- Homepage:
- Size: 3.31 MB
- Stars: 88
- Watchers: 5
- Forks: 9
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-actions - Prow GitHub Actions - Automation of policy enforcement, chat-ops, and automatic PR merging. (Community Resources / GitHub Tools and Management)
- fucking-awesome-actions - Prow GitHub Actions - Automation of policy enforcement, chat-ops, and automatic PR merging. (Community Resources / GitHub Tools and Management)
- awesome-workflows - Prow GitHub Actions - Automation of policy enforcement, chat-ops, and automatic PR merging. (Community Resources / GitHub Tools and Management)
README
# Prow Github Actions ⛵️
This project is inspired by [Prow](https://github.com/kubernetes/test-infra/tree/master/prow) and brings its chat-ops functionality and project management to a simple, Github actions workflow.
> Prow is a Kubernetes based CI/CD system ... and provides GitHub automation in the form of policy enforcement, chat-ops via /foo style commands, and automatic PR merging.
## Quickstart
Check out the _"EXAMPLE"_ issues and pull requests (open and closed) in this repo to see how this works!
---
Run specified actions or jobs for issue and PR comments through a `workflow.yaml` file:
```yaml
name: "Prow github actions"
on:
issue_comment:
types: [created]
jobs:
execute:
runs-on: ubuntu-latest
steps:
- uses: jpmcb/prow-github-actions@v1
with:
prow-commands: '/assign
/unassign
/approve
/retitle
/area
/kind
/priority
/remove
/lgtm
/close
/reopen
/lock
/milestone
/hold
/cc
/uncc'
github-token: "${{ secrets.GITHUB_TOKEN }}"
```
Automatically label PRs with the [Github actions/labeler](https://github.com/actions/labeler/blob/main/README.md) based on globs from `.github/labels.yml`:
```yaml
name: "Pull Request Labeler"
on:
- pull_request_target
jobs:
triage:
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@main
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
```
Your `.github/labels.yaml` may look like:
```yaml
# labels to be used with /area command
area:
- 'bug'
- 'important'
# File globs for PR labeler
tests:
- '**/*.test.ts'
```
You can automatically merge PRs based on a cron schedule if it contains the `lgtm` label:
```yaml
name: "Merge on lgtm label"
on:
schedule:
- cron: "0 * * * *"
jobs:
execute:
runs-on: ubuntu-latest
steps:
- uses: jpmcb/prow-github-actions@v1
with:
jobs: 'lgtm'
github-token: "${{ secrets.GITHUB_TOKEN }}"
# this is optional and defaults to 'merge'
merge-method: 'squash'
```
Prow Github actions also supports removing the lgtm label when a PR is updated
```yaml
name: "Run Jobs on PR"
on: pull_request
jobs:
execute:
runs-on: ubuntu-latest
steps:
- uses: jpmcb/prow-github-actions@v1
with:
jobs: 'lgtm'
github-token: "${{ secrets.GITHUB_TOKEN }}"
```
## Documentation
- [Overview](./docs/overview.md)
- [Commands](./docs/commands.md)
- [Labeling](./docs/labeling.md)
- [PR Labeling](./docs/pr-labeling.md)
- [Cron Jobs](./docs/cron-jobs.md)
- [Automatic PR merging](./docs/automatic-merging.md)
- [PR jobs](./docs/pr-jobs.md)
- [Examples](./docs/examples.md)
- [Contributing](./docs/contributing.md)
---
_open water breeze
the ocean seas are endless
forward to the prow_