GitHub Actions workflows: parameterize over tests, add summary #98
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
| name: treadmill-ci-test | |
| env: | |
| TERM: xterm # Makes tput work in actions output | |
| # Controls when the action will run. Triggers the workflow on pull request and | |
| # merge group checks: | |
| # | |
| # KEEP IN SYNC WITH `environment:` ATTRIBUTE BELOW: | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - dev/test_ci_branch | |
| # Pull requests from forks will not have access to the required GitHub API | |
| # secrets below, even if they are using an appropriate deployment environment | |
| # and the workflow runs have been approved according to this environment's | |
| # rules. We don't know whether this is a bug on GitHub's end or deliberate. | |
| # Either way, for now we disable this workflow to run on PRs until we have | |
| # an API proxy that securely performs these GitHub API calls (adding runners | |
| # and starting Treadmill jobs with those runner registration tokens), which | |
| # allows this workflow to run without access to repository secrets. | |
| #pull_request: | |
| merge_group: # Run CI for the GitHub merge queue | |
| permissions: | |
| contents: read | |
| jobs: | |
| analyze-changes: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| hwci-tests-json: ${{ steps.analyze-changes.outputs.hwci-tests-json }} | |
| steps: | |
| # This is not run within the context of a repository that contains actual | |
| # kernel / userspace code, so there is nothing for us to analyze. Instead | |
| # we clone this very repository and select all test definitions: | |
| - name: Checkout the tock-hardware-ci repository | |
| uses: actions/checkout@v4 | |
| with: | |
| path: tock-hardware-ci | |
| - name: Checkout the tock/tock repository | |
| uses: actions/checkout@v4 | |
| with: | |
| # Checkout the repository at the commit that triggered the workflow | |
| repository: tock/tock | |
| path: tock-tock | |
| - name: Select all defined tests | |
| id: analyze-changes | |
| run: | | |
| pwd | |
| echo "-------" | |
| find tock-hardware-ci/hwci/tests | |
| # Run the select_tests.py script | |
| python3 tock-hardware-ci/hwci/select_tests.py \ | |
| --repo-path tock-tock \ | |
| --hwci-path tock-hardware-ci/hwci \ | |
| --output selected_tests.json | |
| echo "Selected HWCI tests:" | |
| cat selected_tests.json | |
| # Output the tests JSON | |
| hwci_tests_json=$(cat selected_tests.json | jq -c '.') | |
| echo "hwci-tests-json=${hwci_tests_json}" >> "$GITHUB_OUTPUT" | |
| run-treadmill-ci: | |
| needs: [analyze-changes] | |
| uses: ./.github/workflows/treadmill-ci.yml | |
| # This checks whether there is at least one test to run, see | |
| # https://github.com/orgs/community/discussions/27125#discussioncomment-3254720 | |
| if: fromJSON(needs.analyze-changes.outputs.hwci-tests-json)[0] != null | |
| with: | |
| # Only run on a specific repository, as others will not have the right | |
| # environments set up and secrets configured. Forks may want to change | |
| # this parameter. | |
| repository-filter: 'tock/tock-hardware-ci' | |
| # Provide access to the required Treadmill secrets by running in the | |
| # appropriate environment (depending on the on: triggers above) | |
| job-environment: ${{ github.event_name == 'pull_request' && 'treadmill-ci' || 'treadmill-ci-merged' }} | |
| # This workflow tests the tock-hardware-ci scripts itself, so take the | |
| # current GITHUB_SHA: | |
| tock-hardware-ci-ref: ${{ github.sha }} | |
| # Use the latest upstream Tock kernel / userspace components: | |
| tock-kernel-ref: 'master' | |
| libtock-c-ref: 'master' | |
| tests-json: ${{ needs.analyze-changes.outputs.hwci-tests-json }} | |
| secrets: inherit |