Skip to content
Merged
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
153 changes: 32 additions & 121 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,49 +50,21 @@ _If you're using Codeball in another way, please let us know in an issue!_
<summary>▶️ codeball-dry-run.yml</summary>

```yaml
name: Codeball
on: [pull_request]

permissions:
contents: read
issues: write
pull-requests: write

jobs:
codeball:
codeball_job:
runs-on: ubuntu-latest
name: Codeball
steps:

# Start a new Codeball review job
# This step is asynchronous and will return a job id
- name: Trigger Codeball
id: codeball_baller
uses: sturdy-dev/codeball-action/baller@v2


# Wait for Codeball to return the status
- name: Get Status
id: codeball_status
uses: sturdy-dev/codeball-action/status@v2
with:
codeball-job-id: ${{ steps.codeball_baller.outputs.codeball-job-id }}

# If Codeball approved the contribution, add a "codeball:approved" label
- name: Label Approved
uses: sturdy-dev/codeball-action/labeler@v2
if: ${{ steps.codeball_status.outputs.approved == 'true' }}
with:
name: "codeball:approved"
color: "86efac" # green

# If Codeball did not approve the contribution, add a "codeball:needs-review" label
- name: Label Needs Review
uses: sturdy-dev/codeball-action/labeler@v2
if: ${{ steps.codeball_status.outputs.approved == 'false' }}
- name: Codeball
uses: sturdy-dev/codeball-action@v2
with:
name: "codeball:needs-review"
color: "bfdbfe" # blue

approvePullRequests: "false"
labelPullRequestsWhenApproved: "true"
labelPullRequestsWhenReviewNeeded: "true"
failJobsWhenReviewNeeded: "false"
```
</details>

Expand All @@ -102,39 +74,21 @@ jobs:
<summary>▶️ codeball-approve.yml</summary>

```yaml
name: Codeball
on: [pull_request]

permissions:
contents: read
issues: write
pull-requests: write

jobs:
codeball:
codeball_job:
runs-on: ubuntu-latest
name: Codeball
steps:

# Start a new Codeball review job
# This step is asynchronous and will return a job id
- name: Trigger Codeball
id: codeball_baller
uses: sturdy-dev/codeball-action/baller@v2


# Wait for Codeball to return the status
- name: Get Status
id: codeball_status
uses: sturdy-dev/codeball-action/status@v2
with:
codeball-job-id: ${{ steps.codeball_baller.outputs.codeball-job-id }}

# If Codeball approved the contribution, approve the PR
- name: Approve PR
uses: sturdy-dev/codeball-action/approver@v2
if: ${{ steps.codeball_status.outputs.approved == 'true' }}
- name: Codeball
uses: sturdy-dev/codeball-action@v2
with:
message: "Codeball: LGTM! :+1:"
approvePullRequests: "true"
labelPullRequestsWhenApproved: "false"
labelPullRequestsWhenReviewNeeded: "false"
failJobsWhenReviewNeeded: "false"
```
</details>

Expand All @@ -145,6 +99,7 @@ jobs:
<summary>▶️ codeball-filter-files.yml</summary>

```yaml
name: Codeball
on:
pull_request:
# Run Codeball only if files under "/web/" has been modified (and no other files)
Expand All @@ -153,38 +108,18 @@ on:
- '!**'
- '/web/**'

permissions:
contents: read
issues: write
pull-requests: write

jobs:
codeball:
codeball_job:
runs-on: ubuntu-latest
name: Codeball

steps:

# Start a new Codeball review job
# This step is asynchronous and will return a job id
- name: Trigger Codeball
id: codeball_baller
uses: sturdy-dev/codeball-action/baller@v2


# Wait for Codeball to return the status
- name: Get Status
id: codeball_status
uses: sturdy-dev/codeball-action/status@v2
with:
codeball-job-id: ${{ steps.codeball_baller.outputs.codeball-job-id }}

# If Codeball approved the contribution, approve the PR
- name: Approve PR
uses: sturdy-dev/codeball-action/approver@v2
if: ${{ steps.codeball_status.outputs.approved == 'true' }}
- name: Codeball
uses: sturdy-dev/codeball-action@v2
with:
message: "Codeball: LGTM! :+1:"
approvePullRequests: "true"
labelPullRequestsWhenApproved: "true"
labelPullRequestsWhenReviewNeeded: "false"
failJobsWhenReviewNeeded: "false"
```
</details>

Expand All @@ -195,45 +130,21 @@ jobs:
<summary>▶️ codeball-fail-not-approved.yml</summary>

```yaml
name: Codeball
on: [pull_request]

permissions:
contents: read
issues: write
pull-requests: write

jobs:
codeball:
codeball_job:
runs-on: ubuntu-latest
name: Codeball
steps:
# Start a new Codeball review job
# This step is asynchronous and will return a job id
- name: Trigger Codeball
id: codeball_baller
uses: sturdy-dev/codeball-action/baller@v2

# Wait for Codeball to return the status
- name: Get Status
id: codeball_status
uses: sturdy-dev/codeball-action/status@v2
with:
codeball-job-id: ${{ steps.codeball_baller.outputs.codeball-job-id }}

# If Codeball approved the contribution, approve the PR
- name: Approve PR
uses: sturdy-dev/codeball-action/approver@v2
if: ${{ steps.codeball_status.outputs.approved == 'true' }}
- name: Codeball
uses: sturdy-dev/codeball-action@v2
with:
message: 'Codeball: LGTM! :+1:'

# If Codeball didn't approve the contribution, fail the job.
- name: Fail Job
shell: bash
if: ${{ steps.codeball_status.outputs.approved == 'false' }}
run: |
echo "Not approved"
exit 1
approvePullRequests: "true"
labelPullRequestsWhenApproved: "true"
labelPullRequestsWhenReviewNeeded: "false"
failJobsWhenReviewNeeded: "true"
```
</details>

Expand Down