Skip to content

Commit 41f8f2e

Browse files
Kiril Videlovkrlvi
authored andcommitted
Update README templates with feature flag options
1 parent ee6d6bc commit 41f8f2e

File tree

1 file changed

+32
-121
lines changed

1 file changed

+32
-121
lines changed

README.md

Lines changed: 32 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -50,49 +50,21 @@ _If you're using Codeball in another way, please let us know in an issue!_
5050
<summary>▶️ codeball-dry-run.yml</summary>
5151
5252
```yaml
53+
name: Codeball
5354
on: [pull_request]
5455

55-
permissions:
56-
contents: read
57-
issues: write
58-
pull-requests: write
59-
6056
jobs:
61-
codeball:
57+
codeball_job:
6258
runs-on: ubuntu-latest
6359
name: Codeball
6460
steps:
65-
66-
# Start a new Codeball review job
67-
# This step is asynchronous and will return a job id
68-
- name: Trigger Codeball
69-
id: codeball_baller
70-
uses: sturdy-dev/codeball-action/baller@v2
71-
72-
73-
# Wait for Codeball to return the status
74-
- name: Get Status
75-
id: codeball_status
76-
uses: sturdy-dev/codeball-action/status@v2
77-
with:
78-
codeball-job-id: ${{ steps.codeball_baller.outputs.codeball-job-id }}
79-
80-
# If Codeball approved the contribution, add a "codeball:approved" label
81-
- name: Label Approved
82-
uses: sturdy-dev/codeball-action/labeler@v2
83-
if: ${{ steps.codeball_status.outputs.approved == 'true' }}
84-
with:
85-
name: "codeball:approved"
86-
color: "86efac" # green
87-
88-
# If Codeball did not approve the contribution, add a "codeball:needs-review" label
89-
- name: Label Needs Review
90-
uses: sturdy-dev/codeball-action/labeler@v2
91-
if: ${{ steps.codeball_status.outputs.approved == 'false' }}
61+
- name: Codeball
62+
uses: sturdy-dev/codeball-action@v2
9263
with:
93-
name: "codeball:needs-review"
94-
color: "bfdbfe" # blue
95-
64+
approvePullRequests: "false"
65+
labelPullRequestsWhenApproved: "true"
66+
labelPullRequestsWhenReviewNeeded: "true"
67+
failJobsWhenReviewNeeded: "false"
9668
```
9769
</details>
9870
@@ -102,39 +74,21 @@ jobs:
10274
<summary>▶️ codeball-approve.yml</summary>
10375
10476
```yaml
77+
name: Codeball
10578
on: [pull_request]
10679

107-
permissions:
108-
contents: read
109-
issues: write
110-
pull-requests: write
111-
11280
jobs:
113-
codeball:
81+
codeball_job:
11482
runs-on: ubuntu-latest
11583
name: Codeball
11684
steps:
117-
118-
# Start a new Codeball review job
119-
# This step is asynchronous and will return a job id
120-
- name: Trigger Codeball
121-
id: codeball_baller
122-
uses: sturdy-dev/codeball-action/baller@v2
123-
124-
125-
# Wait for Codeball to return the status
126-
- name: Get Status
127-
id: codeball_status
128-
uses: sturdy-dev/codeball-action/status@v2
129-
with:
130-
codeball-job-id: ${{ steps.codeball_baller.outputs.codeball-job-id }}
131-
132-
# If Codeball approved the contribution, approve the PR
133-
- name: Approve PR
134-
uses: sturdy-dev/codeball-action/approver@v2
135-
if: ${{ steps.codeball_status.outputs.approved == 'true' }}
85+
- name: Codeball
86+
uses: sturdy-dev/codeball-action@v2
13687
with:
137-
message: "Codeball: LGTM! :+1:"
88+
approvePullRequests: "true"
89+
labelPullRequestsWhenApproved: "false"
90+
labelPullRequestsWhenReviewNeeded: "false"
91+
failJobsWhenReviewNeeded: "false"
13892
```
13993
</details>
14094
@@ -145,6 +99,7 @@ jobs:
14599
<summary>▶️ codeball-filter-files.yml</summary>
146100
147101
```yaml
102+
name: Codeball
148103
on:
149104
pull_request:
150105
# Run Codeball only if files under "/web/" has been modified (and no other files)
@@ -153,38 +108,18 @@ on:
153108
- '!**'
154109
- '/web/**'
155110

156-
permissions:
157-
contents: read
158-
issues: write
159-
pull-requests: write
160-
161111
jobs:
162-
codeball:
112+
codeball_job:
163113
runs-on: ubuntu-latest
164114
name: Codeball
165-
166115
steps:
167-
168-
# Start a new Codeball review job
169-
# This step is asynchronous and will return a job id
170-
- name: Trigger Codeball
171-
id: codeball_baller
172-
uses: sturdy-dev/codeball-action/baller@v2
173-
174-
175-
# Wait for Codeball to return the status
176-
- name: Get Status
177-
id: codeball_status
178-
uses: sturdy-dev/codeball-action/status@v2
179-
with:
180-
codeball-job-id: ${{ steps.codeball_baller.outputs.codeball-job-id }}
181-
182-
# If Codeball approved the contribution, approve the PR
183-
- name: Approve PR
184-
uses: sturdy-dev/codeball-action/approver@v2
185-
if: ${{ steps.codeball_status.outputs.approved == 'true' }}
116+
- name: Codeball
117+
uses: sturdy-dev/codeball-action@v2
186118
with:
187-
message: "Codeball: LGTM! :+1:"
119+
approvePullRequests: "true"
120+
labelPullRequestsWhenApproved: "true"
121+
labelPullRequestsWhenReviewNeeded: "false"
122+
failJobsWhenReviewNeeded: "false"
188123
```
189124
</details>
190125
@@ -195,45 +130,21 @@ jobs:
195130
<summary>▶️ codeball-fail-not-approved.yml</summary>
196131
197132
```yaml
133+
name: Codeball
198134
on: [pull_request]
199135

200-
permissions:
201-
contents: read
202-
issues: write
203-
pull-requests: write
204-
205136
jobs:
206-
codeball:
137+
codeball_job:
207138
runs-on: ubuntu-latest
208139
name: Codeball
209140
steps:
210-
# Start a new Codeball review job
211-
# This step is asynchronous and will return a job id
212-
- name: Trigger Codeball
213-
id: codeball_baller
214-
uses: sturdy-dev/codeball-action/baller@v2
215-
216-
# Wait for Codeball to return the status
217-
- name: Get Status
218-
id: codeball_status
219-
uses: sturdy-dev/codeball-action/status@v2
220-
with:
221-
codeball-job-id: ${{ steps.codeball_baller.outputs.codeball-job-id }}
222-
223-
# If Codeball approved the contribution, approve the PR
224-
- name: Approve PR
225-
uses: sturdy-dev/codeball-action/approver@v2
226-
if: ${{ steps.codeball_status.outputs.approved == 'true' }}
141+
- name: Codeball
142+
uses: sturdy-dev/codeball-action@v2
227143
with:
228-
message: 'Codeball: LGTM! :+1:'
229-
230-
# If Codeball didn't approve the contribution, fail the job.
231-
- name: Fail Job
232-
shell: bash
233-
if: ${{ steps.codeball_status.outputs.approved == 'false' }}
234-
run: |
235-
echo "Not approved"
236-
exit 1
144+
approvePullRequests: "true"
145+
labelPullRequestsWhenApproved: "true"
146+
labelPullRequestsWhenReviewNeeded: "false"
147+
failJobsWhenReviewNeeded: "true"
237148
```
238149
</details>
239150

0 commit comments

Comments
 (0)