Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# oscar

NOTE: This project is in development, is not a priority and values functionality above
anything else.

Oscar is a bot inspired by [Prow](https://docs.prow.k8s.io/docs/).
And just like Prow, Oscar is a bot that helps you manage your GitHub repositories.
It can answer to commands in the comments of your PRs and Issues such
Expand All @@ -15,6 +18,7 @@ as:
- `/close`: Closes the PR or Issue.
- `/reopen`: Reopens the PR or Issue.
- `/label`: Adds a label to the PR or Issue.
- '/label-remove': Removes a label from the PR or Issue.
- `/triage`: Remove the `needs-triage` label from the PR or Issue.
- `/rename`: Renames the PR or Issue.
- `/reviewers`: Adds reviewers to the PR.
Expand All @@ -30,12 +34,11 @@ as:

Oscar can be run as a GitHub app. This is the recommended way to run Oscar as it is
easier to set up and maintain.
Integrating with GitLab and Gitea is planned for the near future.

## Cloudflare workers

Oscar's advantage is that it can be deployed and used for free on cloudflare workers. The
free tier of cloudflare workers is enough to run Oscar for most repositories (100k
requests/day).
And in extreme cases, you can always pay for the pro plan or enable load balancing to
And in extreme cases, you can always pay for the pro plan or enable load balancing to
spread requests across multiple workers.
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@
},
"dependencies": {
"@ltd/j-toml": "^1.38.0",
"@octokit/webhooks-types": "^7.5.1",
"@tsndr/cloudflare-worker-router": "^3.2.4",
"octokit": "^4.0.2"
"octokit": "^4.0.2",
"pino": "^9.3.2"
}
}
Loading