Fix unnecessary git changes when starting the project #809
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: CI (mandatory checks) | |
| on: | |
| push: | |
| branches-ignore: | |
| - staging | |
| - prod | |
| - devel | |
| tags-ignore: | |
| - staging | |
| - prod | |
| pull_request: | |
| merge_group: | |
| workflow_dispatch: | |
| workflow_call: | |
| env: | |
| USER_ID: 1001 | |
| DOCKER_BUILDKIT: 1 | |
| COMPOSE_DOCKER_CLI_BUILD: 1 | |
| jobs: | |
| api-cs-check: | |
| name: 'Lint: API (php-cs-fixer)' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
| - uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: '8.2.10' | |
| tools: composer:2.6.0 | |
| coverage: xdebug | |
| - name: Get Composer Cache Directory | |
| id: composer-cache | |
| run: 'echo "dir=$(composer config cache-files-dir)" | tr -d "\n" >> $GITHUB_OUTPUT' | |
| working-directory: api | |
| - uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3 | |
| with: | |
| path: ${{ steps.composer-cache.outputs.dir }} | |
| key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-composer- | |
| - run: composer install --no-interaction --no-plugins --no-scripts --prefer-dist | |
| working-directory: api | |
| - run: php vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php -v --dry-run --diff | |
| working-directory: api | |
| frontend-eslint: | |
| name: 'Lint: Frontend (ESLint)' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: '20.6.1' | |
| - uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3 | |
| with: | |
| path: ~/.npm | |
| key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-node- | |
| - run: npm ci --no-audit | |
| working-directory: frontend | |
| - run: | | |
| npm run lint:check:eslint | |
| result=$(npm run lint:check:prettier) | |
| echo $result | |
| if echo $result | grep -E "Code style issues found"; then | |
| exit 1 | |
| fi | |
| working-directory: frontend | |
| client-print-eslint: | |
| name: 'Lint: ClientPrint (ESLint)' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: '20.6.1' | |
| - uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3 | |
| with: | |
| path: ~/.npm | |
| key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-node- | |
| - run: npm ci --no-audit | |
| working-directory: pdf | |
| - run: | | |
| npm run lint:check:eslint | |
| result=$(npm run lint:check:prettier) | |
| echo $result | |
| if echo $result | grep -E "Code style issues found"; then | |
| exit 1 | |
| fi | |
| working-directory: pdf | |
| print-eslint: | |
| name: 'Lint: Print (ESLint)' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: '20.6.1' | |
| - uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3 | |
| with: | |
| path: ~/.npm | |
| key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-node- | |
| - run: npm ci --no-audit | |
| working-directory: print | |
| - run: | | |
| npm run lint:check:eslint | |
| result=$(npm run lint:check:prettier) | |
| echo $result | |
| if echo $result | grep -E "Code style issues found"; then | |
| exit 1 | |
| fi | |
| working-directory: print | |
| e2e-lint: | |
| name: 'Lint: e2e (ESLint)' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: '20.6.1' | |
| - uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3 | |
| with: | |
| path: ~/.npm | |
| key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-node- | |
| - run: npm ci --no-audit | |
| working-directory: e2e | |
| - run: | | |
| npm run lint:check:eslint | |
| result=$(npm run lint:check:prettier) | |
| echo $result | |
| if echo $result | grep -E "Code style issues found"; then | |
| exit 1 | |
| fi | |
| working-directory: e2e | |
| api-tests: | |
| name: 'Tests: API' | |
| runs-on: ubuntu-latest | |
| env: | |
| TEST_DATABASE_URL: postgresql://ecamp3:ecamp3@localhost:5432/ecamp3test?serverVersion=15&charset=utf8 | |
| services: | |
| postgres: | |
| image: 'postgres:15-alpine' | |
| env: | |
| POSTGRES_DB: 'ecamp3test' | |
| POSTGRES_PASSWORD: 'ecamp3' | |
| POSTGRES_USER: 'ecamp3' | |
| ports: | |
| - '5432:5432' | |
| options: >- | |
| --health-cmd pg_isready | |
| --health-interval 10s | |
| --health-timeout 5s | |
| --health-retries 5 | |
| steps: | |
| - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
| - uses: shivammathur/setup-php@v2 | |
| with: | |
| php-version: '8.2.10' | |
| extensions: intl-73.1 | |
| tools: composer:2.6.0 | |
| coverage: xdebug | |
| - name: Get Composer Cache Directory | |
| id: composer-cache | |
| run: 'echo "dir=$(composer config cache-files-dir)" | tr -d "\n" >> $GITHUB_OUTPUT' | |
| working-directory: api | |
| - uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3 | |
| with: | |
| path: ${{ steps.composer-cache.outputs.dir }} | |
| key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-composer- | |
| - run: composer install --prefer-dist --no-progress --no-interaction | |
| working-directory: api | |
| - run: | | |
| mkdir -p var/cache var/log | |
| jwt_passphrase=${JWT_PASSPHRASE:-$(grep ''^JWT_PASSPHRASE='' .env | cut -f 2 -d ''='')} | |
| echo "Generating public / private keys for JWT" | |
| mkdir -p config/jwt | |
| echo "$jwt_passphrase" | openssl genpkey -out config/jwt/private.pem -pass stdin -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096 | |
| echo "$jwt_passphrase" | openssl pkey -in config/jwt/private.pem -passin stdin -out config/jwt/public.pem -pubout | |
| setfacl -R -m u:www-data:rX -m u:"$(whoami)":rwX config/jwt | |
| setfacl -dR -m u:www-data:rX -m u:"$(whoami)":rwX config/jwt | |
| working-directory: api | |
| - run: php bin/console doctrine:migrations:migrate --no-interaction -e test | |
| working-directory: api | |
| - run: composer test | |
| working-directory: api | |
| - name: send coveralls report | |
| run: | | |
| sed -i "s|$(pwd)/api/|api/|g" api/build/logs/clover.xml | |
| api/vendor/bin/php-coveralls -v \ | |
| --coverage_clover api/build/logs/clover.xml \ | |
| --json_path api/build/logs/coveralls-upload.json | |
| env: | |
| COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| COVERALLS_PARALLEL: true | |
| COVERALLS_FLAG_NAME: api | |
| frontend-tests: | |
| name: 'Tests: Frontend' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: '20.6.1' | |
| - uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3 | |
| with: | |
| path: ~/.npm | |
| key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-node- | |
| - run: npm ci --no-audit | |
| working-directory: pdf | |
| - run: npm run build | |
| working-directory: pdf | |
| - run: npm ci --no-audit | |
| working-directory: frontend | |
| - run: npm run build | |
| working-directory: frontend | |
| - run: npm run test:unit | |
| working-directory: frontend | |
| - name: send coverage info | |
| run: | | |
| sed -i "s|src/|frontend/src/|g" frontend/data/coverage/lcov.info | |
| cat frontend/data/coverage/lcov.info | npx coveralls . | |
| env: | |
| COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| COVERALLS_SERVICE_NAME: github | |
| COVERALLS_SERVICE_NUMBER: ${{ github.run_id }} | |
| CI_PULL_REQUEST: ${{ github.event.number }} | |
| COVERALLS_PARALLEL: true | |
| COVERALLS_FLAG_NAME: frontend | |
| print-tests: | |
| name: 'Tests: Print' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: '20.6.1' | |
| - uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3 | |
| with: | |
| path: ~/.npm | |
| key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-node- | |
| - run: npm ci --no-audit | |
| working-directory: print | |
| - run: npm run build | |
| working-directory: print | |
| env: | |
| NODE_OPTIONS: --openssl-legacy-provider | |
| - run: npm run test | |
| working-directory: print | |
| - name: send coverage info | |
| run: | | |
| sed -i "s|SF:|SF:print/|g" print/coverage/lcov.info | |
| cat print/coverage/lcov.info | npx coveralls . | |
| env: | |
| COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| COVERALLS_SERVICE_NAME: github | |
| COVERALLS_SERVICE_NUMBER: ${{ github.run_id }} | |
| CI_PULL_REQUEST: ${{ github.event.number }} | |
| COVERALLS_PARALLEL: true | |
| COVERALLS_FLAG_NAME: print | |
| e2e-tests-build: | |
| name: 'Tests: End-to-end (build job)' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 20 | |
| steps: | |
| - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
| - name: Set up Docker Buildx | |
| id: buildx | |
| uses: docker/setup-buildx-action@v3 | |
| # build API (using cache; provide image to docker compose) | |
| - name: Build docker image (API/PHP) | |
| uses: docker/build-push-action@v5 | |
| with: | |
| file: api/Dockerfile | |
| context: './api' | |
| push: false | |
| load: true | |
| target: api_platform_php_dev | |
| builder: ${{ steps.buildx.outputs.name }} | |
| tags: ecamp/ecamp3-dev-api-php | |
| cache-from: type=gha,scope=api | |
| cache-to: type=gha,scope=api,mode=max | |
| outputs: type=docker,dest=/tmp/ecamp3-dev-api-php.tar | |
| # build caddy (using cache; provide image to docker compose) | |
| - name: Build docker image (Caddy) | |
| uses: docker/build-push-action@v5 | |
| with: | |
| file: api/Dockerfile | |
| context: './api' | |
| push: false | |
| load: true | |
| target: api_platform_caddy | |
| builder: ${{ steps.buildx.outputs.name }} | |
| tags: ecamp/ecamp3-dev-api-caddy | |
| cache-from: type=gha,scope=caddy | |
| cache-to: type=gha,scope=caddy,mode=max | |
| outputs: type=docker,dest=/tmp/ecamp3-dev-api-caddy.tar | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: e2e-tests-images | |
| path: /tmp/ecamp3-dev-*.tar | |
| e2e-tests-run: | |
| name: 'Tests: End-to-end' | |
| runs-on: ubuntu-latest | |
| needs: e2e-tests-build | |
| timeout-minutes: 20 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| browser: | |
| - chrome | |
| - firefox | |
| - edge | |
| steps: | |
| - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
| - run: cp .env.ci .env | |
| - name: Set up Docker Buildx | |
| id: buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - name: Restore tmp folder | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: e2e-tests-images | |
| path: /tmp | |
| - name: Load images | |
| run: | | |
| docker load --input /tmp/ecamp3-dev-api-php.tar | |
| docker load --input /tmp/ecamp3-dev-api-caddy.tar | |
| docker image ls -a --digests | |
| - name: Restore cache volumes (npm, composer) | |
| uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3 | |
| with: | |
| path: .cache | |
| key: docker-compose-${{ hashFiles('frontend/package-lock.json', 'print/package-lock.json', 'api/composer.lock') }}-${{ matrix.browser }} | |
| restore-keys: | | |
| docker-compose- | |
| # start necessary containers | |
| - run: docker compose up -d php caddy frontend pdf print browserless database docker-host | |
| - uses: cypress-io/github-action@v5 | |
| with: | |
| working-directory: e2e | |
| browser: ${{ matrix.browser }} | |
| wait-on: 'http://localhost:3000, http://localhost:3000/api, http://localhost:3000/print/health' | |
| wait-on-timeout: 300 | |
| # store screenshots and videos on GitHub as artifacts, for downloading and debugging in case of problems | |
| - uses: actions/upload-artifact@v3 | |
| if: always() | |
| with: | |
| name: cypress-output-${{ matrix.browser }} | |
| path: | | |
| e2e/data/**/* | |
| # print docker container logs (good for debugging; can be disabled again later on) | |
| - run: docker compose logs --tail="all" | |
| if: always() | |
| coveralls-finished: | |
| name: 'Finish coveralls report' | |
| needs: | |
| - api-tests | |
| - frontend-tests | |
| - print-tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: coverallsapp/github-action@master | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| parallel-finished: true | |
| ci-passed-event: | |
| name: 'Send out CI success event' | |
| if: github.event_name == 'push' && (github.event.pull_request && github.event.pull_request.number) | |
| needs: | |
| - api-cs-check | |
| - frontend-eslint | |
| - print-eslint | |
| - e2e-lint | |
| - api-tests | |
| - frontend-tests | |
| - print-tests | |
| - e2e-tests-run | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: peter-evans/repository-dispatch@bf47d102fdb849e755b0b0023ea3e81a44b6f570 # v2 | |
| with: | |
| event-type: ci-passed | |
| client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}' |