mirror of
https://github.com/symfony/recipes.git
synced 2026-09-12 07:36:30 +03:00
Merge branch 'main'
* main: Adding a new callable recipes readme GH action Always run "Setup PHP" steps Clean CI config Enable Automerge Specify license for recipes-checker-main lint:pull-request Test recipes on Symfony 5&6 Fix escaping args in commands Fix linting JSON files Hit raw.githubusercontent.com to work around rate limiting Add callable action to repopulate the recipe archives Copying the "archived/" directory from recipes-checker Add reusable workflows
This commit is contained in:
Nicolas Grekas
@@ -0,0 +1,19 @@
|
||||
name: Cleanup Flex testing endpoint
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
|
||||
jobs:
|
||||
flex-cleanup:
|
||||
name: Cleanup Flex testing endpoint
|
||||
runs-on: Ubuntu-20.04
|
||||
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
|
||||
-
|
||||
name: Cleanup Flex testing endpoint
|
||||
run: |
|
||||
git push origin :flex/pull-${{ github.event.number }} || true
|
||||
@@ -0,0 +1,46 @@
|
||||
name: Update Flex Archives
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
branch:
|
||||
default: master
|
||||
required: false
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
flex-update-archived:
|
||||
name: Update Flex Archives
|
||||
runs-on: Ubuntu-20.04
|
||||
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
id: checkout
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
-
|
||||
name: Install tools
|
||||
run: |
|
||||
git config --global user.email ""
|
||||
git config --global user.name "github-action[bot]"
|
||||
cd .github
|
||||
wget -q -O recipes-checker.zip https://codeload.github.com/symfony-tools/recipes-checker/zip/refs/heads/main
|
||||
unzip recipes-checker.zip
|
||||
cd recipes-checker-main
|
||||
composer install --ansi --no-dev
|
||||
-
|
||||
name: Update Flex Archives
|
||||
run: |
|
||||
git switch ${{ inputs.branch }}
|
||||
|
||||
mkdir .github/archived
|
||||
php .github/recipes-checker-main/run generate:archived-recipes . ${{ inputs.branch }} .github/archived
|
||||
|
||||
git switch flex/main
|
||||
cp -a .github/archived .
|
||||
git add archived/
|
||||
git commit -m 'Update Flex archives' || true
|
||||
git push origin -f flex/main
|
||||
@@ -0,0 +1,53 @@
|
||||
name: Update Flex endpoint
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
branch:
|
||||
default: main
|
||||
required: false
|
||||
type: string
|
||||
contrib:
|
||||
required: false
|
||||
type: boolean
|
||||
versions_json:
|
||||
required: false
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
flex-update:
|
||||
name: Update Flex endpoint
|
||||
runs-on: Ubuntu-20.04
|
||||
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
id: checkout
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
-
|
||||
name: Install tools
|
||||
run: |
|
||||
git config --global user.email ""
|
||||
git config --global user.name "github-action[bot]"
|
||||
cd .github
|
||||
wget -q -O recipes-checker.zip https://codeload.github.com/symfony-tools/recipes-checker/zip/refs/heads/main
|
||||
unzip recipes-checker.zip
|
||||
cd recipes-checker-main
|
||||
composer install --ansi --no-dev
|
||||
|
||||
-
|
||||
name: Update Flex endpoint
|
||||
run: |
|
||||
mkdir .github/flex-endpoint
|
||||
git ls-tree HEAD */*/* | php .github/recipes-checker-main/run generate:flex-endpoint ${{ github.repository }} ${{ inputs.branch }} flex/main .github/flex-endpoint ${{ inputs.versions_json }} ${{ inputs.contrib && '--contrib' || '' }}
|
||||
git switch flex/main
|
||||
git rm -q *.json
|
||||
mv .github/flex-endpoint/*.json .
|
||||
git add *.json
|
||||
cp -a .github/flex-endpoint/archived .
|
||||
git add archived/
|
||||
git commit -m 'Update Flex endpoint' || true
|
||||
git push origin -f flex/main
|
||||
@@ -0,0 +1,287 @@
|
||||
name: Q&A
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
branch:
|
||||
default: main
|
||||
required: false
|
||||
type: string
|
||||
contrib:
|
||||
required: false
|
||||
type: boolean
|
||||
find_yaml:
|
||||
required: false
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
run-checks:
|
||||
name: Run checks
|
||||
runs-on: Ubuntu-20.04
|
||||
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
id: checkout
|
||||
with:
|
||||
fetch-depth: 0
|
||||
ref: 'refs/pull/${{ github.event.number }}/merge'
|
||||
|
||||
-
|
||||
name: Install tools
|
||||
run: |
|
||||
git config --global user.email ""
|
||||
git config --global user.name "github-action[bot]"
|
||||
cd .github
|
||||
wget -q -O recipes-checker.zip https://codeload.github.com/symfony-tools/recipes-checker/zip/refs/heads/main
|
||||
unzip recipes-checker.zip
|
||||
cd recipes-checker-main
|
||||
composer install --ansi --no-dev
|
||||
|
||||
-
|
||||
name: Check manifest.json files
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
.github/recipes-checker-main/run lint:manifests ${{ inputs.contrib && '--contrib' || '' }}
|
||||
|
||||
-
|
||||
name: Remove non-patched packages
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
.github/recipes-checker-main/run list-unpatched-packages $GITHUB_EVENT_PATH ${{ secrets.GITHUB_TOKEN }} | xargs -r -n10 rm -rf
|
||||
|
||||
-
|
||||
name: Generate Flex testing endpoint
|
||||
if: "always() && steps.checkout.outcome == 'success' && github.base_ref == inputs.branch"
|
||||
run: |
|
||||
mkdir .github/flex-endpoint
|
||||
git ls-tree HEAD */*/* | php .github/recipes-checker-main/run generate:flex-endpoint ${{ github.repository }} ${{ inputs.branch }} flex/pull-${{ github.event.number }} .github/flex-endpoint ${{ inputs.contrib && '--contrib' || '' }}
|
||||
git stash
|
||||
git switch -c pr
|
||||
git switch --orphan flex/pull-${{ github.event.number }}
|
||||
git reset --hard -q
|
||||
mv .github/flex-endpoint/*.json .
|
||||
git add *.json
|
||||
git commit -m 'Create Flex endpoint' || true
|
||||
git push origin -f flex/pull-${{ github.event.number }}
|
||||
git switch pr
|
||||
git stash pop -q
|
||||
|
||||
-
|
||||
name: Enable Automerge
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: gh pr merge --auto --squash ${{ github.event.number }}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
-
|
||||
name: Compute diff between recipe versions
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
find * -mindepth 1 -maxdepth 1 -type d | sort \
|
||||
| .github/recipes-checker-main/run diff-recipe-versions 'https://raw.githubusercontent.com/${{ github.repository }}/flex/pull-${{ github.event.number }}/index.json' \
|
||||
> .github/diff-recipe-versions.md
|
||||
|
||||
-
|
||||
name: Post diff between recipe versions
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
uses: marocchino/sticky-pull-request-comment@v2
|
||||
with:
|
||||
path: .github/diff-recipe-versions.md
|
||||
|
||||
-
|
||||
name: No symlinks
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
SYMLINKS=$(find * -type l)
|
||||
|
||||
if [[ "" != "$SYMLINKS" ]]; then echo -e "::error::Symlinks are not allowed\nFound $SYMLINKS\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: No .yml, use .yaml
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
YMLS=$(find * -name '*.yml' ${{ inputs.find_yaml }})
|
||||
|
||||
if [[ "" != "$YMLS" ]]; then echo -e "::error::*.yml files should renamed to *.yaml\nFound $YMLS\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: No .gitkeep, use .gitignore
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
GITKEEPS=$(find * -name .gitkeep)
|
||||
|
||||
if [[ "" != "$GITKEEPS" ]]; then echo -e "::error::.gitkeep files should be renamed to .gitignore\nFound $GITKEEPS\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: 4 spaces indentation
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
ERRORS=$(find * -name '*.yaml' -or -name '*.json' \
|
||||
| xargs -n1 grep -P -H -n -v '^(( )*[^ \t]|$)' \
|
||||
| cut -d: -f1-2 \
|
||||
| sed 's/\(.*\):\([0-9]*\)$/\\n::error file=\1,line=\2::Indendation must be a multiple of 4 spaces/' || true)
|
||||
|
||||
if [[ "" != "$ERRORS" ]]; then echo -e "$ERRORS\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: Text files end with a newline
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
ERRORS=$(find * -name '*.yaml' -or -name '*.yml' -or -name '*.txt' -or -name '*.md' -or -name '*.markdown' \
|
||||
-or -name '*.json' -or -name '*.rst' -or -name '*.php' -or -name '*.js' -or -name '*.css' -or -name '*.twig' \
|
||||
| xargs -n1 -P0 bash -c '[ -n "$(tail -c1 "$0")" ] && echo ::error file="$0",line=$((1 + `wc -l "$0" | cut -d" " -f1`))::Should end with a newline' || true)
|
||||
|
||||
if [[ "" != "$ERRORS" ]]; then echo -e "$ERRORS\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: Use https when referencing symfony.com
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
ERRORS=$(grep -H -n 'http://.*symfony\.com' * -r \
|
||||
| cut -d: -f1-2 \
|
||||
| sed 's/\(.*\):\([0-9]*\)$/\\n::error file=\1,line=\2::Use https when referencing symfony.com/' || true)
|
||||
|
||||
if [[ "" != "$ERRORS" ]]; then echo -e "$ERRORS\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: manifest.json is found
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
MISSING=$(find * -mindepth 2 -maxdepth 2 -type d '!' -exec test -f '{}/manifest.json' ';' -print)
|
||||
|
||||
if [[ "" != "$MISSING" ]]; then echo -e "::error::Recipes must define a \"manifest.json\" file\nFile not found in $MISSING\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: JSON files are valid
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
ERRORS=$(find * -name '*.json' | xargs -n1 -P0 bash -c 'ERR=$(cd / && python -mjson.tool '$(pwd)'/"$0" 2>&1 1> /dev/null) || echo \\n::error file="$0",line=`echo "${ERR#*: line }" | cut -d" " -f 1`::${ERR%%: line *}')
|
||||
|
||||
if [[ "" != "$ERRORS" ]]; then echo -e "$ERRORS\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: YAML files are valid
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
find * -name '*.yaml' -or -name '*.yml' | .github/recipes-checker-main/run lint:yaml
|
||||
|
||||
-
|
||||
name: Packages exist on packagist.org
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
.github/recipes-checker-main/run lint:packages
|
||||
|
||||
-
|
||||
name: Contribution is under MIT and has no merge commits
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
.github/recipes-checker-main/run lint:pull-request --license=MIT $GITHUB_EVENT_PATH ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
-
|
||||
name: Parameters should be defined via the "container" configurator
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
ERRORS=$(find */*/*/config/packages/ -name '*.yaml' -or -name '*.yml' \
|
||||
| xargs -n1 grep -P -H -n '^parameters:' \
|
||||
| cut -d: -f1-2 \
|
||||
| sed 's/\(.*\):\([0-9]*\)$/\\n::error file=\1,line=\2::"parameters" should be defined via the "container" configurator instead/' || true)
|
||||
|
||||
if [[ "" != "$ERRORS" ]]; then echo -e "$ERRORS\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: Underscore notation under config/
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
ERRORS=$(find */*/*/config -type f \
|
||||
| grep -v -P '[^/]+/[^/]+/[^/]+/config/[0-9a-z_./]+$' \
|
||||
| xargs -n1 -I{} echo "::error file={}::Underscore notation is required for file and directory names under config/" || true)
|
||||
|
||||
if [[ "" != "$ERRORS" ]]; then echo -e "$ERRORS\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: Yaml nulls should not be "~"
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
ERRORS=$(find * -name '*.yaml' -or -name '*.yml' \
|
||||
| xargs -n1 grep -F -H -n ': ~'\
|
||||
| cut -d: -f1-2 \
|
||||
| sed 's/\(.*\):\([0-9]*\)$/\\n::error file=\1,line=\2::"~" should be replaced with "null"/' || true)
|
||||
|
||||
if [[ "" != "$ERRORS" ]]; then echo -e "$ERRORS\n"; exit 1; fi
|
||||
|
||||
-
|
||||
name: Symfony commands should not be wrapped in a Makefile
|
||||
if: "always() && steps.checkout.outcome == 'success'"
|
||||
run: |
|
||||
ERRORS=$(find * -name Makefile \
|
||||
| xargs -n1 grep -P -H -n 'bin/console|\$\(CONSOLE\)' \
|
||||
| cut -d: -f1-2 \
|
||||
| sed 's/\(.*\):\([0-9]*\)$/\\n::error file=\1,line=\2::Symfony commands should not be wrapped in a Makefile/' || true)
|
||||
|
||||
if [[ "" != "$ERRORS" ]]; then echo -e "$ERRORS\n"; exit 1; fi
|
||||
|
||||
create-project:
|
||||
needs: run-checks
|
||||
name: Run updated recipes
|
||||
runs-on: Ubuntu-20.04
|
||||
|
||||
steps:
|
||||
-
|
||||
name: Export configuration
|
||||
continue-on-error: true
|
||||
id: config
|
||||
run: |
|
||||
PACKAGES=$(curl -s https://raw.githubusercontent.com/${{ github.repository }}/flex/pull-${{ github.event.number }}/index.json | jq -r '.recipes | to_entries | map(.key+":^"+.value[-1]) | join(" ")')
|
||||
echo PACKAGES=$PACKAGES >> $GITHUB_ENV
|
||||
[[ "" != "$PACKAGES" ]]
|
||||
|
||||
-
|
||||
name: Setup PHP 7.4
|
||||
if: "always() && steps.config.outcome == 'success'"
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
coverage: "none"
|
||||
php-version: "7.4"
|
||||
|
||||
-
|
||||
name: Create-project with skeleton ^5
|
||||
if: "always() && steps.config.outcome == 'success'"
|
||||
run: |
|
||||
set -x
|
||||
php -v
|
||||
composer create-project --ansi "symfony/skeleton:^5" v5
|
||||
cd v5
|
||||
composer config extra.symfony.allow-contrib ${{ inputs.contrib && 'true' || 'false' }}
|
||||
composer config minimum-stability dev
|
||||
export SYMFONY_ENDPOINT=https://raw.githubusercontent.com/${{ github.repository }}/flex/pull-${{ github.event.number }}/index.json
|
||||
composer require -W --ansi $PACKAGES
|
||||
EXIT_CODE=$?
|
||||
|
||||
if [[ EXIT_CODE -eq 2 ]]; then
|
||||
echo -e "\n#\n#\n# You can ignore this error if your package does not support Symfony 5\n#\n#\n#\n"
|
||||
fi
|
||||
|
||||
exit $EXIT_CODE
|
||||
|
||||
-
|
||||
name: Setup PHP 8.1
|
||||
if: "always() && steps.config.outcome == 'success'"
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
coverage: "none"
|
||||
php-version: "8.1"
|
||||
|
||||
-
|
||||
name: Create-project with skeleton ^6
|
||||
if: "always() && steps.config.outcome == 'success'"
|
||||
run: |
|
||||
set -x
|
||||
php -v
|
||||
composer create-project --ansi "symfony/skeleton:^6" v6
|
||||
cd v6
|
||||
composer config extra.symfony.allow-contrib ${{ inputs.contrib && 'true' || 'false' }}
|
||||
composer config minimum-stability dev
|
||||
export SYMFONY_ENDPOINT=https://raw.githubusercontent.com/${{ github.repository }}/flex/pull-${{ github.event.number }}/index.json
|
||||
composer require -W --ansi $PACKAGES
|
||||
@@ -0,0 +1,48 @@
|
||||
name: Update RECIPES.md
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
# branch where the RECIPES.md will be committed
|
||||
branch:
|
||||
required: true
|
||||
type: string
|
||||
contrib:
|
||||
required: false
|
||||
type: boolean
|
||||
|
||||
jobs:
|
||||
call-recipe-readme-update:
|
||||
name: Update RECIPES.md
|
||||
runs-on: Ubuntu-20.04
|
||||
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
id: checkout
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
-
|
||||
name: Install tools
|
||||
run: |
|
||||
git config --global user.email ""
|
||||
git config --global user.name "github-action[bot]"
|
||||
cd .github
|
||||
wget -q -O recipes-checker.zip https://codeload.github.com/symfony-tools/recipes-checker/zip/refs/heads/main
|
||||
unzip recipes-checker.zip
|
||||
cd recipes-checker-main
|
||||
composer install --ansi --no-dev
|
||||
|
||||
-
|
||||
name: Generate Recipes README
|
||||
run: |
|
||||
mkdir .github/recipe-readme
|
||||
git switch flex/main
|
||||
php .github/recipes-checker-main/run generate:recipes-readme index.json ${{ inputs.contrib && '--contrib' || '' }} > .github/recipe-readme/RECIPES.md
|
||||
git switch ${{ inputs.branch }}
|
||||
cp .github/recipe-readme/RECIPES.md RECIPES.md
|
||||
git add RECIPES.md
|
||||
git commit -m 'Update Recipes README' || true
|
||||
git push origin ${{ inputs.branch }}
|
||||
Reference in New Issue
Block a user