cli-ci #689
Workflow file for this run
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
| # Copyright (c) 2022 Sharezone UG (haftungsbeschränkt) | |
| # Licensed under the EUPL-1.2-or-later. | |
| # | |
| # You may obtain a copy of the Licence at: | |
| # https://joinup.ec.europa.eu/software/page/eupl | |
| # | |
| # SPDX-License-Identifier: EUPL-1.2 | |
| name: cli-ci | |
| concurrency: | |
| group: cli-ci-${{ github.head_ref }} | |
| # In order to conserve the use of GitHub Actions, we cancel the running action | |
| # of the previous commit. This means that if you first commit "A" and then | |
| # commit "B" to the pull request a few minutes later, the workflow for commit | |
| # "A" will be cancelled. | |
| cancel-in-progress: true | |
| on: | |
| pull_request: | |
| types: | |
| - opened | |
| - synchronize | |
| - reopened | |
| # It's important to trigger this workflow again when the pull is changing | |
| # from a draft pull request to a ready for review pull request. | |
| # | |
| # Some jobs are skipped when the pull request is a draft. Therefore, we | |
| # need to trigger these jobs again when the pull request is changing to | |
| # ready for review. | |
| - ready_for_review | |
| merge_group: | |
| types: | |
| - checks_requested | |
| env: | |
| CI_CD_DART_SCRIPTS_PACKAGE_PATH: "tools/sz_repo_cli/" | |
| jobs: | |
| # We can't use the official "paths" filter because it has no support for merge | |
| # groups and we would need some kind of fallback CI when a check is required | |
| # but ignored because of the path filter. | |
| # | |
| # See: | |
| # * https://github.com/community/community/discussions/45899 (merge groups) | |
| # * https://github.com/github/docs/commit/4364076e0fb56c2579ae90cd048939eaa2c18954 | |
| # (workaround for required checks with path filters) | |
| changes: | |
| runs-on: ubuntu-22.04 | |
| outputs: | |
| changesFound: ${{ steps.filter.outputs.changesFound }} | |
| steps: | |
| - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab | |
| - uses: AurorNZ/paths-filter@7c547bdd24124b0d69e07c96b62fd7fec5ced19a | |
| id: filter | |
| with: | |
| filters: | | |
| changesFound: | |
| # When we change the Flutter version, we need to trigger this workflow. | |
| - ".fvm/fvm_config.json" | |
| # Changes in the CLI directory should trigger the CI. | |
| - "tools/sz_repo_cli/**" | |
| # We trigger also this workflow, if this workflow is changed, so that new | |
| # changes will be applied. | |
| - ".github/workflows/cli_ci.yml" | |
| # The following paths are excluded from the above paths. It's important to | |
| # list the paths at the end of the file, so that the exclude paths are | |
| # applied. | |
| # | |
| # See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-including-and-excluding-paths. | |
| - "!**.md" | |
| - "!**.mdx" | |
| - "!**.gitignore" | |
| - "!**/firebase.json" | |
| - "!**/.firebaserc" | |
| analyze: | |
| needs: changes | |
| runs-on: ubuntu-22.04 | |
| # In draft PRs we might use TODOs temporarily. | |
| # In this case the analyze pipeline would fail, thus we won't run it. | |
| if: ${{ github.event.pull_request.draft == false && needs.changes.outputs.changesFound == 'true' }} | |
| steps: | |
| - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab | |
| - name: Set Flutter version from FVM config file to environment variables | |
| uses: kuhnroyal/flutter-fvm-config-action@e91317131a2da710b9cd9b7a24f2c0ade9eeb61d | |
| - uses: subosito/flutter-action@48cafc24713cca54bbe03cdc3a423187d413aafa | |
| with: | |
| flutter-version: ${{ env.FLUTTER_VERSION }} | |
| channel: ${{ env.FLUTTER_CHANNEL }} | |
| # Use format expected by FVM. | |
| # Else this won't be recognized as an installed version when setting | |
| # '.../flutter' as the FVM Flutter version cache folder. | |
| cache-path: "${{ runner.tool_cache }}/flutter/:version:" | |
| - name: Install FVM | |
| run: | | |
| flutter pub global activate fvm 2.4.1 | |
| fvm config --cache-path '${{ runner.tool_cache }}/flutter' | |
| - name: Activate sz_repo_cli package | |
| run: fvm flutter pub global activate --source path "$CI_CD_DART_SCRIPTS_PACKAGE_PATH" | |
| # So we can just use "sz COMMAND" instead of "dart ../path/to/script.dart ..." | |
| - run: echo $(realpath ./bin) >> $GITHUB_PATH | |
| - name: Run code analysis via "sz analyze" (formatting, issues, spacing ...) | |
| run: sz analyze --max-concurrent-packages 3 --package-timeout-minutes 15 | |
| test: | |
| needs: changes | |
| # Because we run our the tests for all packages for now, we need to use a | |
| # macOS runner because we have Golden Tests in some packages which requires | |
| # a macOS runner. | |
| # | |
| # When the Sharezone CLI supports filters for the test command (like | |
| # `--only="tools/sz_repo_cli"`), we can change this to a Linux runner. | |
| runs-on: ubuntu-22.04 | |
| if: ${{ needs.changes.outputs.changesFound == 'true' }} | |
| steps: | |
| - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab | |
| - name: Set Flutter version from FVM config file to environment variables | |
| uses: kuhnroyal/flutter-fvm-config-action@e91317131a2da710b9cd9b7a24f2c0ade9eeb61d | |
| - uses: subosito/flutter-action@48cafc24713cca54bbe03cdc3a423187d413aafa | |
| with: | |
| flutter-version: ${{ env.FLUTTER_VERSION }} | |
| channel: ${{ env.FLUTTER_CHANNEL }} | |
| # Use format expected by FVM. | |
| # Else this won't be recognized as an installed version when setting | |
| # '.../flutter' as the FVM Flutter version cache folder. | |
| cache-path: "${{ runner.tool_cache }}/flutter/:version:" | |
| - name: Install FVM | |
| run: | | |
| flutter pub global activate fvm 2.4.1 | |
| fvm config --cache-path '${{ runner.tool_cache }}/flutter' | |
| - name: Activate sz_repo_cli package | |
| run: fvm flutter pub global activate --source path "$CI_CD_DART_SCRIPTS_PACKAGE_PATH" | |
| # So we can just use "sz COMMAND" instead of "dart ../path/to/script.dart ..." | |
| - run: echo $(pwd)/bin >> $GITHUB_PATH | |
| # Currently, we run the tests for all packages because we don't have a | |
| # filter for the test command yet. | |
| # | |
| # Because of this, we need to exclude the golden tests because they | |
| # require a macOS runner. | |
| - name: Run tests via "sz test" | |
| run: sz test \ | |
| -c 4 \ | |
| --package-timeout-minutes 15 \ | |
| --exclude-goldens |