[Docs] Add CONTRIBUTING.md #5537
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
name: Symfony UX | |
on: | |
push: | |
paths-ignore: | |
- 'src/*/doc/**' | |
- 'ux.symfony.com/**' | |
pull_request: | |
paths-ignore: | |
- 'src/*/doc/**' | |
- 'ux.symfony.com/**' | |
jobs: | |
coding-style-js: | |
name: JavaScript Coding Style | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- run: corepack enable | |
- name: Get yarn cache directory path | |
id: yarn-cache-dir-path | |
run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT | |
- uses: actions/cache@v4 | |
id: yarn-cache | |
with: | |
path: ${{ steps.yarn-cache-dir-path.outputs.dir }} | |
key: ${{ runner.os }}-yarn-${{ hashFiles('**/package.json') }} | |
restore-keys: | | |
${{ runner.os }}-yarn- | |
- run: yarn --immutable | |
- run: yarn check-lint | |
- run: yarn check-format | |
js-dist-current: | |
name: Check for UnBuilt JS Dist Files | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- run: corepack enable | |
- name: Get yarn cache directory path | |
id: yarn-cache-dir-path | |
run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT | |
- uses: actions/cache@v4 | |
id: yarn-cache | |
with: | |
path: ${{ steps.yarn-cache-dir-path.outputs.dir }} | |
key: ${{ runner.os }}-yarn-${{ hashFiles('**/package.json') }} | |
restore-keys: | | |
${{ runner.os }}-yarn- | |
- run: yarn --immutable && yarn build | |
- name: Check if js dist files are current | |
id: changes | |
run: | | |
echo "STATUS=$(git status --porcelain)" >> $GITHUB_OUTPUT | |
- name: No changes found | |
if: steps.changes.outputs.STATUS == '' | |
run: | | |
echo "git status is clean" | |
- name: Changes were found | |
if: steps.changes.outputs.STATUS != '' | |
run: | | |
echo "JS dist files need to be rebuilt" | |
echo "${{ steps.changes.outputs.STATUS }}" | |
exit 1 | |
tests-php-components: | |
runs-on: ubuntu-latest | |
outputs: | |
components: ${{ steps.components.outputs.components }} | |
steps: | |
- uses: actions/checkout@v4 | |
- id: components | |
run: | | |
components=$(find src/ -mindepth 2 -type f -name composer.json -not -path "*/vendor/*" -printf '%h\n' | jq -R -s -c 'split("\n")[:-1] | map(. | sub("^src/";"")) | sort') | |
echo "$components" | |
echo "components=$components" >> $GITHUB_OUTPUT | |
tests-php: | |
runs-on: ubuntu-latest | |
needs: tests-php-components | |
strategy: | |
fail-fast: false | |
matrix: | |
php-version: ['8.1', '8.3', '8.4'] | |
include: | |
- php-version: '8.1' | |
dependency-version: 'lowest' | |
- php-version: '8.3' | |
dependency-version: 'highest' | |
- php-version: '8.4' | |
dependency-version: 'highest' | |
component: ${{ fromJson(needs.tests-php-components.outputs.components )}} | |
exclude: | |
- component: Map # does not support PHP 8.1 | |
php-version: '8.1' | |
- component: Map/src/Bridge/Google # does not support PHP 8.1 | |
php-version: '8.1' | |
- component: Map/src/Bridge/Leaflet # does not support PHP 8.1 | |
php-version: '8.1' | |
- component: Swup # has no tests | |
- component: Turbo # has its own workflow (test-turbo.yml) | |
- component: Typed # has no tests | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: shivammathur/setup-php@v2 | |
with: | |
php-version: ${{ matrix.php-version }} | |
- name: Install root packages | |
uses: ramsey/composer-install@v3 | |
with: | |
working-directory: ${{ github.workspace }} | |
dependency-versions: ${{ matrix.dependency-version }} | |
- name: Build root packages | |
run: php .github/build-packages.php | |
working-directory: ${{ github.workspace }} | |
- name: Install ${{ matrix.component }} packages | |
uses: ramsey/composer-install@v3 | |
with: | |
working-directory: "src/${{ matrix.component }}" | |
dependency-versions: ${{ matrix.dependency-version }} | |
- name: ${{ matrix.component }} Tests | |
working-directory: "src/${{ matrix.component }}" | |
run: vendor/bin/simple-phpunit | |
tests-js: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- run: corepack enable | |
- name: Get yarn cache directory path | |
id: yarn-cache-dir-path | |
run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT | |
- uses: actions/cache@v4 | |
id: yarn-cache | |
with: | |
path: ${{ steps.yarn-cache-dir-path.outputs.dir }} | |
key: ${{ runner.os }}-yarn-${{ hashFiles('**/package.json') }} | |
restore-keys: | | |
${{ runner.os }}-yarn- | |
- run: yarn --immutable | |
- run: yarn playwright install | |
- run: yarn test |