docs: add examples to scan report instruction stub #2274
Workflow file for this run
This file contains hidden or 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: Full CI | |
| on: | |
| push: | |
| pull_request: | |
| workflow_dispatch: | |
| inputs: | |
| BEC_WIDGETS_BRANCH: | |
| description: "Branch of BEC Widgets to install" | |
| required: false | |
| type: string | |
| BEC_CORE_BRANCH: | |
| description: "Branch of BEC Core to install" | |
| required: false | |
| type: string | |
| OPHYD_DEVICES_BRANCH: | |
| description: "Branch of Ophyd Devices to install" | |
| required: false | |
| type: string | |
| permissions: | |
| pull-requests: write | |
| jobs: | |
| check_pr_status: | |
| uses: ./.github/workflows/check_pr.yml | |
| formatter: | |
| needs: check_pr_status | |
| if: needs.check_pr_status.outputs.branch-pr == '' | |
| uses: ./.github/workflows/formatter.yml | |
| unit-test: | |
| needs: [check_pr_status, formatter] | |
| if: needs.check_pr_status.outputs.branch-pr == '' | |
| uses: ./.github/workflows/pytest.yml | |
| with: | |
| BEC_WIDGETS_BRANCH: ${{ inputs.BEC_WIDGETS_BRANCH || 'main' }} | |
| BEC_CORE_BRANCH: ${{ inputs.BEC_CORE_BRANCH || github.head_ref || github.sha}} | |
| OPHYD_DEVICES_BRANCH: ${{ inputs.OPHYD_DEVICES_BRANCH || 'main' }} | |
| unit-test-matrix: | |
| needs: [check_pr_status, formatter] | |
| if: needs.check_pr_status.outputs.branch-pr == '' | |
| uses: ./.github/workflows/pytest-matrix.yml | |
| with: | |
| BEC_WIDGETS_BRANCH: ${{ inputs.BEC_WIDGETS_BRANCH || 'main' }} | |
| BEC_CORE_BRANCH: ${{ inputs.BEC_CORE_BRANCH || github.head_ref || github.sha}} | |
| OPHYD_DEVICES_BRANCH: ${{ inputs.OPHYD_DEVICES_BRANCH || 'main' }} | |
| end2end-test: | |
| needs: [check_pr_status, formatter] | |
| if: needs.check_pr_status.outputs.branch-pr == '' | |
| uses: ./.github/workflows/end2end.yml | |
| with: | |
| BEC_WIDGETS_BRANCH: ${{ inputs.BEC_WIDGETS_BRANCH || 'main' }} | |
| BEC_CORE_BRANCH: ${{ inputs.BEC_CORE_BRANCH || github.head_ref || github.sha}} | |
| OPHYD_DEVICES_BRANCH: ${{ inputs.OPHYD_DEVICES_BRANCH || 'main' }} | |
| PYTHON_VERSION: "3.11" | |
| child-repos: | |
| needs: [check_pr_status, formatter] | |
| if: needs.check_pr_status.outputs.branch-pr == '' | |
| uses: ./.github/workflows/child_repos.yml | |
| with: | |
| BEC_WIDGETS_BRANCH: ${{ inputs.BEC_WIDGETS_BRANCH || 'main' }} | |
| BEC_CORE_BRANCH: ${{ inputs.BEC_CORE_BRANCH || github.head_ref || github.sha}} | |
| OPHYD_DEVICES_BRANCH: ${{ inputs.OPHYD_DEVICES_BRANCH || 'main' }} | |
| plugin-repos: | |
| needs: [check_pr_status, formatter, unit-test, unit-test-matrix] | |
| if: needs.check_pr_status.outputs.branch-pr == '' | |
| uses: ./.github/workflows/plugin_repos.yml | |
| with: | |
| BEC_WIDGETS_BRANCH: ${{ inputs.BEC_WIDGETS_BRANCH || 'main' }} | |
| BEC_CORE_BRANCH: ${{ inputs.BEC_CORE_BRANCH || github.head_ref || github.sha}} | |
| OPHYD_DEVICES_BRANCH: ${{ inputs.OPHYD_DEVICES_BRANCH || 'main' }} | |
| secrets: | |
| GH_READ_TOKEN: ${{ secrets.GH_READ_TOKEN }} | |
| upload-coverage: | |
| needs: [unit-test, end2end-test] | |
| if: needs.check_pr_status.outputs.branch-pr == '' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Download unit test coverage | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: coverage-unit | |
| path: ./coverage-unit | |
| - name: Download e2e test coverage | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: coverage-e2e | |
| path: ./coverage-e2e | |
| - name: Upload combined coverage to Codecov | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| files: ./coverage-unit/coverage-unit.xml,./coverage-e2e/coverage-e2e.xml | |
| slug: bec-project/bec | |
| fail_ci_if_error: true |