Skip to content

Commit ad8acb2

Browse files
committed
Updated README for v2
1 parent 7825ba8 commit ad8acb2

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
name: Run Codeball
2424
steps:
2525
- name: Codeball AI Actions
26-
uses: sturdy-dev/codeball-action@v1
26+
uses: sturdy-dev/codeball-action@v2
2727
# with:
2828
# do-label: "true" # Configure if the action should label approved contributions
2929
# label-name: "codeball:approved" # Configure the label name to set if Codeball approves the contribution
@@ -32,6 +32,29 @@ jobs:
3232

3333
2. 🎉 That's it! Codeball will now run on your pull requests, and will pre-approve your PR if it's a good one!
3434

35+
## Customizations
36+
37+
Codeball Actions are built on multiple smaller building-blocks, that are heavily configurable through GitHub Actions.
38+
39+
The Codeball sub-actions are:
40+
41+
* Baller – Triggers new Codeball Jobs
42+
* Status – Waits for the the Codeball result
43+
* Approver – Approves PRs
44+
* Labeler – Adds labels to PRs
45+
46+
### Example: "Dry-run" mode, labels all PRs with the Codeball Result
47+
48+
<details>
49+
<summary>codeball.yml</summary>
50+
51+
## Heading
52+
1. A numbered
53+
2. list
54+
* With some
55+
* Sub bullets
56+
</details>
57+
3558
## Troubleshooting
3659

3760
### Permissions
@@ -51,4 +74,4 @@ permissions:
5174
5275
By default, only pull requests from a fork does not have "write" permissions when running in GitHub Actions, and those Pull Requests can not be approved.
5376
54-
If you're using forks from a private repository, and want to use Codeball on Pull Requests created from a fork. Enable "Send write tokens to workflows from fork pull requests" on the repository ([docs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)).
77+
If you're using forks from a private repository, and want to use Codeball on Pull Requests created from a fork. Enable "Send write tokens to workflows from fork pull requests" on the repository ([docs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)).

0 commit comments

Comments
 (0)