From 4d811938850fc2ba06d6aa50daf58f7f13f994ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20M=C3=B6ller?= Date: Thu, 4 Jan 2024 14:11:44 +0100 Subject: [PATCH] Enhancement: Synchronize with ergebnis/php-package-template --- .github/dependabot.yaml | 2 +- .github/settings.yml | 4 ++-- .github/workflows/integrate.yaml | 11 +---------- .github/workflows/release.yaml | 13 +++++++++++++ .github/workflows/renew.yaml | 5 +---- Makefile | 10 +--------- composer.json | 8 +++++++- psalm-baseline.xml | 2 +- 8 files changed, 27 insertions(+), 28 deletions(-) diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml index da211c1..fdebab6 100644 --- a/.github/dependabot.yaml +++ b/.github/dependabot.yaml @@ -1,4 +1,4 @@ -# https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates +# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file version: 2 diff --git a/.github/settings.yml b/.github/settings.yml index fb46760..1f5da68 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -77,7 +77,7 @@ repository: archived: false default_branch: "main" delete_branch_on_merge: true - description: ":seedling: + :eyes: Provides a Twig loader for files with YAML front-matter." + description: "๐ŸŒฑ + ๐Ÿ‘€ Provides a composer package with a Twig loader for files with YAML front-matter." enable_automated_security_fixes: true enable_vulnerability_alerts: true has_discussions: false @@ -92,4 +92,4 @@ repository: # https://docs.github.com/en/rest/reference/repos#replace-all-repository-topics - topics: "php, twig, front-matter" + topics: "php, twig, loader, yaml, front-matter" diff --git a/.github/workflows/integrate.yaml b/.github/workflows/integrate.yaml index 3e118dc..5c75840 100644 --- a/.github/workflows/integrate.yaml +++ b/.github/workflows/integrate.yaml @@ -179,9 +179,6 @@ jobs: - name: "Run ergebnis/composer-normalize" run: "composer normalize --ansi --dry-run" - - name: "Create cache directory for friendsofphp/php-cs-fixer" - run: "mkdir -p .build/php-cs-fixer/" - - name: "Cache cache directory for friendsofphp/php-cs-fixer" uses: "actions/cache@v3.3.2" with: @@ -192,7 +189,7 @@ jobs: php-${{ matrix.php-version }}-php-cs-fixer- - name: "Run friendsofphp/php-cs-fixer" - run: "vendor/bin/php-cs-fixer fix --ansi --config=.php-cs-fixer.php --diff --dry-run --verbose" + run: "vendor/bin/php-cs-fixer fix --ansi --config=.php-cs-fixer.php --diff --dry-run --show-progress=dots --verbose" dependency-analysis: name: "Dependency Analysis" @@ -349,9 +346,6 @@ jobs: with: dependencies: "${{ matrix.dependencies }}" - - name: "Create cache directory for rector/rector" - run: "mkdir -p .build/rector/" - - name: "Cache cache directory for rector/rector" uses: "actions/cache@v3.3.2" with: @@ -461,9 +455,6 @@ jobs: with: dependencies: "${{ matrix.dependencies }}" - - name: "Create cache directory for vimeo/psalm" - run: "mkdir -p .build/psalm/" - - name: "Run vimeo/psalm" run: "vendor/bin/psalm --config=psalm.xml --output-format=github --shepherd --show-info=false --stats --threads=4" diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index dc949a5..061d46b 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -20,3 +20,16 @@ jobs: uses: "ergebnis/.github/actions/github/release/create@1.9.0" with: github-token: "${{ secrets.ERGEBNIS_BOT_TOKEN }}" + + - name: "Post to twitter.com about release" + uses: "Eomm/why-don-t-you-tweet@v1.1.0" + env: + TWITTER_ACCESS_TOKEN: "${{ secrets.ERGEBNIS_TWITTER_ACCESS_TOKEN }}" + TWITTER_ACCESS_TOKEN_SECRET: "${{ secrets.ERGEBNIS_TWITTER_ACCESS_TOKEN_SECRET }}" + TWITTER_CONSUMER_API_KEY: "${{ secrets.ERGEBNIS_TWITTER_CONSUMER_API_KEY }}" + TWITTER_CONSUMER_API_SECRET: "${{ secrets.ERGEBNIS_TWITTER_CONSUMER_API_KEY_SECRET }}" + with: + tweet-message: | + ๐ŸŒฑ + ๐Ÿ‘€ Just released: ${{ github.event.repository.owner.login }}/${{ github.event.repository.name }}:${{ env.RELEASE_TAG }}. + + ${{ env.RELEASE_HTML_URL }} diff --git a/.github/workflows/renew.yaml b/.github/workflows/renew.yaml index 9dbaa5c..a3bc567 100644 --- a/.github/workflows/renew.yaml +++ b/.github/workflows/renew.yaml @@ -56,9 +56,6 @@ jobs: with: dependencies: "${{ matrix.dependencies }}" - - name: "Create cache directory for friendsofphp/php-cs-fixer" - run: "mkdir -p .build/php-cs-fixer" - - name: "Cache cache directory for friendsofphp/php-cs-fixer" uses: "actions/cache@v3.3.2" with: @@ -69,7 +66,7 @@ jobs: php-${{ matrix.php-version }}-php-cs-fixer- - name: "Run friendsofphp/php-cs-fixer" - run: "vendor/bin/php-cs-fixer fix --ansi --config=.php-cs-fixer.php --diff --verbose" + run: "vendor/bin/php-cs-fixer fix --ansi --config=.php-cs-fixer.php --diff --show-progress=dots --verbose" - name: "Commit modified files" uses: "stefanzweifel/git-auto-commit-action@v5.0.0" diff --git a/Makefile b/Makefile index 631f35e..d7ae653 100644 --- a/Makefile +++ b/Makefile @@ -7,15 +7,13 @@ backward-compatibility-analysis: vendor ## Runs a backward-compatibility analysi .PHONY: code-coverage code-coverage: vendor ## Collects coverage from running unit tests with phpunit/phpunit - mkdir -p .build/phpunit/ vendor/bin/phpunit --configuration=test/Unit/phpunit.xml --coverage-text .PHONY: coding-standards coding-standards: vendor ## Lints YAML files with yamllint, normalizes composer.json with ergebnis/composer-normalize, and fixes code style issues with friendsofphp/php-cs-fixer yamllint -c .yamllint.yaml --strict . composer normalize - mkdir -p .build/php-cs-fixer/ - vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --diff --verbose + vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --diff --show-progress=dots --verbose .PHONY: dependency-analysis dependency-analysis: phive vendor ## Runs a dependency analysis with maglnet/composer-require-checker @@ -27,17 +25,14 @@ help: ## Displays this list of targets with descriptions .PHONY: mutation-tests mutation-tests: vendor ## Runs mutation tests with infection/infection - mkdir -p .build/infection/ vendor/bin/infection --configuration=infection.json .PHONY: phive phive: .phive ## Installs dependencies with phive - mkdir -p .build/phive/ PHIVE_HOME=.build/phive phive install --trust-gpg-keys 0x033E5F8D801A2F8D .PHONY: refactoring refactoring: vendor ## Runs automated refactoring with rector/rector - mkdir -p .build/rector/ vendor/bin/rector process --config=rector.php .PHONY: security-analysis @@ -46,19 +41,16 @@ security-analysis: vendor ## Runs a security analysis with composer .PHONY: static-code-analysis static-code-analysis: vendor ## Runs a static code analysis with vimeo/psalm - mkdir -p .build/psalm/ vendor/bin/psalm --config=psalm.xml --clear-cache vendor/bin/psalm --config=psalm.xml --show-info=false --stats --threads=4 .PHONY: static-code-analysis-baseline static-code-analysis-baseline: vendor ## Generates a baseline for static code analysis with vimeo/psalm - mkdir -p .build/psalm/ vendor/bin/psalm --config=psalm.xml --clear-cache vendor/bin/psalm --config=psalm.xml --set-baseline=psalm-baseline.xml .PHONY: tests tests: vendor ## Runs unit tests with phpunit/phpunit - mkdir -p .build/phpunit/ vendor/bin/phpunit --configuration=test/Unit/phpunit.xml vendor: composer.json composer.lock diff --git a/composer.json b/composer.json index d358481..541581b 100644 --- a/composer.json +++ b/composer.json @@ -1,8 +1,14 @@ { "name": "ergebnis/twig-front-matter", - "description": "Provides a GitHub repository template for a PHP library, using GitHub Actions.", + "description": "Provides a Twig loader for files with YAML front-matter.", "license": "MIT", "type": "library", + "keywords": [ + "twig", + "loader", + "yaml", + "front-matter" + ], "authors": [ { "name": "Andreas Mรถller", diff --git a/psalm-baseline.xml b/psalm-baseline.xml index 1889f65..685052f 100644 --- a/psalm-baseline.xml +++ b/psalm-baseline.xml @@ -1,5 +1,5 @@ - + $key