-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# Objective - Make CI friendlier ## Solution - CI now says hello to new contributor - for some jobs with non obvious solutions to failures, give more context - example run should say which example failed - example doc should say the next action to do (add metadata or run the update script) - MSRV will say when it needs updating I'm not completely sure everything is working and will try to trigger failures in this PR
- Loading branch information
Showing
3 changed files
with
257 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| name: CI - PR Comments | ||
|
|
||
| # This workflow has write permissions on the repo | ||
| # It must not checkout a PR and run untrusted code | ||
|
|
||
| # Also requesting write permissions on PR to be able to comment | ||
| permissions: | ||
| pull-requests: 'write' | ||
|
|
||
| on: | ||
| workflow_run: | ||
| workflows: ["CI"] | ||
| types: | ||
| - completed | ||
|
|
||
| jobs: | ||
| example-run: | ||
| runs-on: ubuntu-latest | ||
| if: > | ||
| github.event.workflow_run.event == 'pull_request' && | ||
| github.event.workflow_run.conclusion == 'failure' | ||
| steps: | ||
| - name: 'Download artifact' | ||
| id: find-artifact | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| result-encoding: string | ||
| script: | | ||
| var artifacts = await github.rest.actions.listWorkflowRunArtifacts({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| run_id: ${{github.event.workflow_run.id }}, | ||
| }); | ||
| var matchArtifacts = artifacts.data.artifacts.filter((artifact) => { | ||
| return artifact.name == "example-run" | ||
| }); | ||
| if (matchArtifacts.length == 0) { return "false" } | ||
| var matchArtifact = matchArtifacts[0]; | ||
| var download = await github.rest.actions.downloadArtifact({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| artifact_id: matchArtifact.id, | ||
| archive_format: 'zip', | ||
| }); | ||
| var fs = require('fs'); | ||
| fs.writeFileSync('${{github.workspace}}/example-run.zip', Buffer.from(download.data)); | ||
| return "true" | ||
| - run: unzip example-run.zip | ||
| if: ${{ steps.find-artifact.outputs.result == 'true' }} | ||
| - name: 'Comment on PR' | ||
| if: ${{ steps.find-artifact.outputs.result == 'true' }} | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| script: | | ||
| var fs = require('fs'); | ||
| var issue_number = Number(fs.readFileSync('./NR')); | ||
| var last_example_run = fs.readFileSync('./last_example_run'); | ||
| await github.rest.issues.createComment({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| issue_number: issue_number, | ||
| body: 'Example ' + last_example_run + ' failed to run, please try running it locally and check the result.' | ||
| }); | ||
| missing-examples: | ||
| runs-on: ubuntu-latest | ||
| if: > | ||
| github.event.workflow_run.event == 'pull_request' && | ||
| github.event.workflow_run.conclusion == 'failure' | ||
| steps: | ||
| - name: 'Download artifact' | ||
| id: find-artifact | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| result-encoding: string | ||
| script: | | ||
| var artifacts = await github.rest.actions.listWorkflowRunArtifacts({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| run_id: ${{github.event.workflow_run.id }}, | ||
| }); | ||
| var matchArtifacts = artifacts.data.artifacts.filter((artifact) => { | ||
| return artifact.name == "missing-examples" | ||
| }); | ||
| if (matchArtifacts.length == 0) { return "false" } | ||
| var matchArtifact = matchArtifacts[0]; | ||
| var download = await github.rest.actions.downloadArtifact({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| artifact_id: matchArtifact.id, | ||
| archive_format: 'zip', | ||
| }); | ||
| var fs = require('fs'); | ||
| fs.writeFileSync('${{github.workspace}}/missing-examples.zip', Buffer.from(download.data)); | ||
| return "true" | ||
| - run: unzip missing-examples.zip | ||
| if: ${{ steps.find-artifact.outputs.result == 'true' }} | ||
| - name: 'Comment on PR' | ||
| if: ${{ steps.find-artifact.outputs.result == 'true' }} | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| script: | | ||
| var fs = require('fs'); | ||
| var issue_number = Number(fs.readFileSync('./NR')); | ||
| if (existsSync('./missing-metadata')) { | ||
| await github.rest.issues.createComment({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| issue_number: issue_number, | ||
| body: 'You added a new example but didn't add metadata for it. Please update the root Cargo.toml file.' | ||
| }); | ||
| } | ||
| if (existsSync('./missing-update')) { | ||
| await github.rest.issues.createComment({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| issue_number: issue_number, | ||
| body: 'You added a new example but didn't update the readme. Please run `cargo run -p build-example-pages -- update` to update it, and commit the file change.' | ||
| }); | ||
| } | ||
| msrv: | ||
| runs-on: ubuntu-latest | ||
| if: > | ||
| github.event.workflow_run.event == 'pull_request' && | ||
| github.event.workflow_run.conclusion == 'failure' | ||
| steps: | ||
| - name: 'Download artifact' | ||
| id: find-artifact | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| result-encoding: string | ||
| script: | | ||
| var artifacts = await github.rest.actions.listWorkflowRunArtifacts({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| run_id: ${{github.event.workflow_run.id }}, | ||
| }); | ||
| var matchArtifacts = artifacts.data.artifacts.filter((artifact) => { | ||
| return artifact.name == "msrv" | ||
| }); | ||
| if (matchArtifacts.length == 0) { return "false" } | ||
| var matchArtifact = matchArtifacts[0]; | ||
| var download = await github.rest.actions.downloadArtifact({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| artifact_id: matchArtifact.id, | ||
| archive_format: 'zip', | ||
| }); | ||
| var fs = require('fs'); | ||
| fs.writeFileSync('${{github.workspace}}/msrv.zip', Buffer.from(download.data)); | ||
| return "true" | ||
| - run: unzip msrv.zip | ||
| if: ${{ steps.find-artifact.outputs.result == 'true' }} | ||
| - name: 'Comment on PR' | ||
| if: ${{ steps.find-artifact.outputs.result == 'true' }} | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| script: | | ||
| var fs = require('fs'); | ||
| var issue_number = Number(fs.readFileSync('./NR')); | ||
| await github.rest.issues.createComment({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| issue_number: issue_number, | ||
| body: 'Your PR increases Bevy Minimum Supported Rust Version. Please update the `rust-version` field in the root Cargo.toml file.' | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| name: Welcome new contributors | ||
|
|
||
| # This workflow has write permissions on the repo | ||
| # It must not checkout a PR and run untrusted code | ||
|
|
||
| on: pull_request_target | ||
|
|
||
| jobs: | ||
| welcome: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/github-script@v6 | ||
| with: | ||
| script: | | ||
| // Get a list of all issues created by the PR opener | ||
| // See: https://octokit.github.io/rest.js/#pagination | ||
| const creator = context.payload.sender.login | ||
| const opts = github.rest.issues.listForRepo.endpoint.merge({ | ||
| ...context.issue, | ||
| creator, | ||
| state: 'all' | ||
| }) | ||
| const issues = await github.paginate(opts) | ||
| for (const issue of issues) { | ||
| if (issue.number === context.issue.number) { | ||
| continue | ||
| } | ||
| if (issue.pull_request) { | ||
| return // Creator is already a contributor. | ||
| } | ||
| } | ||
| await github.rest.issues.createComment({ | ||
| issue_number: context.issue.number, | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| body: `**Welcome**, new contributor! | ||
| Please make sure you're read our [contributing guide](CONTRIBUTING.md) and we look forward to reviewing your Pull request shortly ✨` | ||
| }) |