Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: add dependency analysis workflow #738

Merged
merged 8 commits into from
May 26, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 0 additions & 78 deletions .github/workflows/ci.yml.dist

This file was deleted.

87 changes: 87 additions & 0 deletions .github/workflows/dependency-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---

name: 🔐 Dependency analysis

on: # yamllint disable-line rule:truthy
push:
branches:
- master
paths:
- 'config/**'
- 'src/**'
- 'tests/**'
- '.php-cs-fixer.dist.php'
- 'composer.json'
- 'composer.lock'
- 'composer-require-checker.json'
pull_request:
branches:
- master
paths:
- 'config/**'
- 'src/**'
- 'tests/**'
- '.php-cs-fixer.dist.php'
- 'composer.json'
- 'composer.lock'
- 'composer-require-checker.json'

jobs:
dependency-analysis:
timeout-minutes: 4
runs-on: ${{ matrix.os }}
concurrency:
cancel-in-progress: true
group: dependency-analysis-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
strategy:
fail-fast: true
matrix:
os:
- ubuntu-latest
php-version:
- '8.2'
dependencies:
- locked

steps:
- name: 📦 Check out the codebase
uses: actions/[email protected]

- name: 🛠️ Setup PHP
uses: shivammathur/[email protected]
with:
php-version: ${{ matrix.php-version }}
extensions: none, ctype, dom, json, mbstring, simplexml, tokenizer, xml, xmlwriter, pdo, curl, fileinfo, pdo_mysql
ini-values: error_reporting=E_ALL
coverage: none
tools: phive

- name: 🛠️ Setup problem matchers
run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"

- name: 🤖 Validate composer.json and composer.lock
run: composer validate --ansi --strict

- name: 🔍 Get composer cache directory
uses: wayofdev/gh-actions/actions/composer/[email protected]

- name: ♻️ Restore cached dependencies installed with composer
uses: actions/[email protected]
with:
path: ${{ env.COMPOSER_CACHE_DIR }}
key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}
restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-

- name: 📥 Install "${{ matrix.dependencies }}" dependencies
uses: wayofdev/gh-actions/actions/composer/[email protected]
with:
dependencies: ${{ matrix.dependencies }}

- name: 📥 Install dependencies with phive
uses: wayofdev/gh-actions/actions/phive/[email protected]
with:
phive-home: '.phive'
trust-gpg-keys: 0xC00543248C87FB13,0x033E5F8D801A2F8D

- name: 🔬 Run maglnet/composer-require-checker
run: .phive/composer-require-checker check --ansi --config-file="$(pwd)/composer-require-checker.json" --verbose
Comment on lines +46 to +87
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The steps for setting up the environment, validating dependencies, and running checks are correctly sequenced and utilize well-maintained actions. Consider adding a fallback cache key in the caching step to improve cache hits.

-          restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-
+          restore-keys: |
+            php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-
+            php-${{ matrix.php-version }}-composer-

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
steps:
- name: 📦 Check out the codebase
uses: actions/[email protected]
- name: 🛠️ Setup PHP
uses: shivammathur/[email protected]
with:
php-version: ${{ matrix.php-version }}
extensions: none, ctype, dom, json, mbstring, simplexml, tokenizer, xml, xmlwriter, pdo, curl, fileinfo, pdo_mysql
ini-values: error_reporting=E_ALL
coverage: none
tools: phive
- name: 🛠️ Setup problem matchers
run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
- name: 🤖 Validate composer.json and composer.lock
run: composer validate --ansi --strict
- name: 🔍 Get composer cache directory
uses: wayofdev/gh-actions/actions/composer/[email protected]
- name: ♻️ Restore cached dependencies installed with composer
uses: actions/[email protected]
with:
path: ${{ env.COMPOSER_CACHE_DIR }}
key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}
restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-
- name: 📥 Install "${{ matrix.dependencies }}" dependencies
uses: wayofdev/gh-actions/actions/composer/[email protected]
with:
dependencies: ${{ matrix.dependencies }}
- name: 📥 Install dependencies with phive
uses: wayofdev/gh-actions/actions/phive/[email protected]
with:
phive-home: '.phive'
trust-gpg-keys: 0xC00543248C87FB13,0x033E5F8D801A2F8D
- name: 🔬 Run maglnet/composer-require-checker
run: .phive/composer-require-checker check --ansi --config-file="$(pwd)/composer-require-checker.json" --verbose
- name: ♻️ Restore cached dependencies installed with composer
uses: actions/[email protected]
with:
path: ${{ env.COMPOSER_CACHE_DIR }}
key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}
restore-keys: |
php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-
php-${{ matrix.php-version }}-composer-

12 changes: 12 additions & 0 deletions .github/workflows/static-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ on: # yamllint disable-line rule:truthy
- 'src/**'
- 'tests/**'
- '.php-cs-fixer.dist.php'
- 'composer.json'
- 'composer.lock'
- 'phpstan.neon.dist'
- 'phpstan-baseline.neon'
- 'psalm.xml'
- 'psalm-baseline.xml'
pull_request:
branches:
- master
Expand All @@ -17,6 +23,12 @@ on: # yamllint disable-line rule:truthy
- 'src/**'
- 'tests/**'
- '.php-cs-fixer.dist.php'
- 'composer.json'
- 'composer.lock'
- 'phpstan.neon.dist'
- 'phpstan-baseline.neon'
- 'psalm.xml'
- 'psalm-baseline.xml'

name: 🔍 Static analysis

Expand Down
Loading