From ca60f4b82237cfdd0ae36c60b1dcea5005e592b1 Mon Sep 17 00:00:00 2001 From: Kiril Videlov Date: Mon, 13 Jun 2022 16:01:48 +0200 Subject: [PATCH] Update README templates with feature flag options --- README.md | 153 ++++++++++++------------------------------------------ 1 file changed, 32 insertions(+), 121 deletions(-) diff --git a/README.md b/README.md index d96fa8b..3570e69 100644 --- a/README.md +++ b/README.md @@ -50,49 +50,21 @@ _If you're using Codeball in another way, please let us know in an issue!_ ▶️ codeball-dry-run.yml ```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" ``` @@ -102,39 +74,21 @@ jobs: ▶️ codeball-approve.yml ```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" ``` @@ -145,6 +99,7 @@ jobs: ▶️ codeball-filter-files.yml ```yaml +name: Codeball on: pull_request: # Run Codeball only if files under "/web/" has been modified (and no other files) @@ -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" ``` @@ -195,45 +130,21 @@ jobs: ▶️ codeball-fail-not-approved.yml ```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" ```