Skip to content

Commit

Permalink
Adapt pull request workflow to work properly for PRs from forked repo…
Browse files Browse the repository at this point in the history
…sitories (#169)

Resolves #168
  • Loading branch information
OptimumCode authored Jul 27, 2024
1 parent 4516be1 commit 4e186ca
Show file tree
Hide file tree
Showing 6 changed files with 144 additions and 71 deletions.
76 changes: 76 additions & 0 deletions .github/workflows/benchmark-upload.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Upload and compare benchmark results

on:
workflow_run:
types: [completed]
workflows: ['Running benchmark']

jobs:
upload-benchmark-results:
if: (github.event.workflow_run.event == 'push' || github.event.workflow_run.event == 'pull_request') && github.repository == 'OptimumCode/json-schema-validator'
runs-on: ubuntu-latest
env:
RESULTS_DIR: bench-results
permissions:
# deployments permission to deploy GitHub pages website
deployments: write
# contents permission to update benchmark contents in gh-pages branch
contents: write
# pull-requests permission to create comments on PR in case of alert
pull-requests: write
strategy:
# to make sure results are submitted one by one
max-parallel: 1
matrix:
include:
- artifact-pattern: 'bench-result-*'
results-name: KMP JSON schema validator
alert: true
- artifact-pattern: 'bench-comparison-result-*'
results-name: Compare KMP JSON schema validator
alert: false
name: 'Process benchmark results for ${{ matrix.results-name }}'
steps:
- name: 'Checkout Repository'
uses: actions/checkout@v4
- name: Download benchmark results
uses: actions/download-artifact@v4
with:
pattern: ${{ matrix.artifact-pattern }}
path: ${{ env.RESULTS_DIR }}
merge-multiple: true
run-id: ${{ github.event.workflow_run.id }}
- name: Show downloaded artifacts
run: tree ${{ env.RESULTS_DIR }}
- name: Prepare and join benchmark reports
id: prep
run: |
for report in $(find ./${{ env.RESULTS_DIR }} -type f -name "*.json")
do
file_name=$(basename "$report")
platform="${file_name%.*}"
jq "[ .[] | .benchmark |= \"${platform}.\" + ltrimstr(\"io.github.optimumcode.json.schema.benchmark.\") | .params |= map_values(. |= split(\"/\")[-1]) ]" $report > ${{ env.RESULTS_DIR }}/$platform.json
done
AGGREGATED_REPORT=aggregated.json
# Joined reports looks like this: [[{},{}], [{},{}]]
# We need to transform them into this: [{},{}]
ls ${{ env.RESULTS_DIR }}/*.json
jq -s '[ .[] | .[] ]' ${{ env.RESULTS_DIR }}/*.json > $AGGREGATED_REPORT
echo "report=$AGGREGATED_REPORT" >> $GITHUB_OUTPUT
- name: Store benchmark result
uses: benchmark-action/github-action-benchmark@v1
with:
name: ${{ matrix.results-name }}
tool: 'jmh'
output-file-path: ${{ steps.prep.outputs.report }}
alert-comment-cc-users: "@OptimumCode"
comment-on-alert: ${{ matrix.alert }}
summary-always: true
alert-threshold: '150%'
fail-threshold: '200%'
max-items-in-chart: 50
github-token: ${{ secrets.GITHUB_TOKEN }}
# Push and deploy GitHub pages branch automatically only if run in main repo and not in PR
auto-push: ${{ github.event.workflow_run.event == 'push' }}


68 changes: 0 additions & 68 deletions .github/workflows/benchmark.yml
Original file line number Diff line number Diff line change
Expand Up @@ -138,71 +138,3 @@ jobs:
with:
name: bench-comparison-result-${{ matrix.os }}
path: ${{ env.BENCHMARK_RESULTS }}/comparison/**/*.json

upload-benchmark-results:
if: (github.event_name == 'push' || github.event_name == 'pull_request') && github.repository == 'OptimumCode/json-schema-validator'
needs:
- benchmark-matrix
runs-on: ubuntu-latest
env:
RESULTS_DIR: bench-results
permissions:
# deployments permission to deploy GitHub pages website
deployments: write
# contents permission to update benchmark contents in gh-pages branch
contents: write
# pull-requests permission to create comments on PR in case of alert
pull-requests: write
strategy:
# to make sure results are submitted one by one
max-parallel: 1
matrix:
include:
- artifact-pattern: 'bench-result-*'
results-name: KMP JSON schema validator
alert: true
- artifact-pattern: 'bench-comparison-result-*'
results-name: Compare KMP JSON schema validator
alert: false
name: 'Process benchmark results for ${{ matrix.results-name }}'
steps:
- name: 'Checkout Repository'
uses: actions/checkout@v4
- name: Download benchmark results
uses: actions/download-artifact@v4
with:
pattern: ${{ matrix.artifact-pattern }}
path: ${{ env.RESULTS_DIR }}
merge-multiple: true
- name: Show downloaded artifacts
run: tree ${{ env.RESULTS_DIR }}
- name: Prepare and join benchmark reports
id: prep
run: |
for report in $(find ./${{ env.RESULTS_DIR }} -type f -name "*.json")
do
file_name=$(basename "$report")
platform="${file_name%.*}"
jq "[ .[] | .benchmark |= \"${platform}.\" + ltrimstr(\"io.github.optimumcode.json.schema.benchmark.\") | .params |= map_values(. |= split(\"/\")[-1]) ]" $report > ${{ env.RESULTS_DIR }}/$platform.json
done
AGGREGATED_REPORT=aggregated.json
# Joined reports looks like this: [[{},{}], [{},{}]]
# We need to transform them into this: [{},{}]
ls ${{ env.RESULTS_DIR }}/*.json
jq -s '[ .[] | .[] ]' ${{ env.RESULTS_DIR }}/*.json > $AGGREGATED_REPORT
echo "report=$AGGREGATED_REPORT" >> $GITHUB_OUTPUT
- name: Store benchmark result
uses: benchmark-action/github-action-benchmark@v1
with:
name: ${{ matrix.results-name }}
tool: 'jmh'
output-file-path: ${{ steps.prep.outputs.report }}
alert-comment-cc-users: "@OptimumCode"
comment-on-alert: ${{ matrix.alert }}
summary-always: true
alert-threshold: '150%'
fail-threshold: '200%'
max-items-in-chart: 50
github-token: ${{ secrets.GITHUB_TOKEN }}
# Push and deploy GitHub pages branch automatically only if run in main repo and not in PR
auto-push: ${{ github.event_name != 'pull_request' }}
6 changes: 6 additions & 0 deletions .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ on:
description: "enabled uploading coverage report to codecov"
required: false
default: false
collect-code-coverage:
type: boolean
description: "enables collecting coverage reports and uploading them as artifacts"
required: false
default: false
secrets:
CODECOV_TOKEN:
description: "token to upload codecov report"
Expand Down Expand Up @@ -50,6 +55,7 @@ jobs:
run-on: ubuntu-latest
task: linuxAllTest
upload-code-coverage: ${{ inputs.upload-code-coverage }}
collect-code-coverage: ${{ inputs.collect-code-coverage }}
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
check-macos:
Expand Down
11 changes: 11 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ on:
description: "enabled uploading coverage report to codecov"
required: false
default: false
collect-code-coverage:
type: boolean
description: "enables collecting coverage reports and uploading them as artifacts"
required: false
default: false
secrets:
CODECOV_TOKEN:
description: "token to upload codecov report"
Expand Down Expand Up @@ -66,3 +71,9 @@ jobs:
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
- name: Collect coverage reports
if: inputs.collect-code-coverage && github.actor != 'dependabot[bot]'
uses: actions/upload-artifact@v4
with:
name: coverage-reports
path: '**/build/reports/kover/report.xml'
37 changes: 37 additions & 0 deletions .github/workflows/code-coverage-upload.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Upload code coverage results

on:
workflow_run:
workflows: ['Check the PR']
types: [completed]

jobs:
upload:
runs-on: ubuntu-latest
if: github.event.workflow_run.actor.name != 'dependabot[bot]' && github.repository == 'OptimumCode/json-schema-validator'
steps:
- name: 'Checkout Repository'
uses: actions/checkout@v4
with:
ref: ${{ github.event.workflow_run.head_branch }}
- name: Download benchmark results
uses: actions/download-artifact@v4
with:
name: coverage-reports
path: reports/
run-id: ${{ github.event.workflow_run.id }}
- name: Download PR number
uses: actions/download-artifact@v4
with:
name: pr-number
path: '.'
run-id: ${{ github.event.workflow_run.id }}
- id: trigger
run: echo "pr-number=$(cat pr_number)" >> GITHUB_OUTPUT
- name: Test pull_requests objects
run: echo ${{ github.event.workflow_run.pull_requests }}
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v4
with:
override_pr: ${{ steps.trigger.outputs.pr-number }}
token: ${{ secrets.CODECOV_TOKEN }}
17 changes: 14 additions & 3 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@ jobs:
check-pr:
uses: ./.github/workflows/build-and-test.yml
with:
upload-code-coverage: true
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
collect-code-coverage: true
danger-check:
runs-on: ubuntu-latest
permissions:
Expand All @@ -71,4 +69,17 @@ jobs:
dangerfile: Dangerfile.df.kts
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
store-pr-number:
runs-on: ubuntu-latest
steps:
- name: Save PR number
env:
PR_NUMBER: ${{ github.event.number }}
run: |
mkdir -p ./pr
echo $PR_NUMBER > ./pr/pr_number
- uses: actions/upload-artifact@v4
with:
name: pr-number
path: pr/

0 comments on commit 4e186ca

Please sign in to comment.