From 223b3cfbada885ad21f7e95b848add41d7523728 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20M=C3=B6ller?= Date: Sun, 7 Jan 2024 17:43:53 +0100 Subject: [PATCH] Enhancement: Synchronize with ergebnis/php-package-template --- .github/CONTRIBUTING.md | 2 +- .github/dependabot.yaml | 2 +- .github/settings.yml | 2 +- .github/workflows/integrate.yaml | 14 +------------- .github/workflows/release.yaml | 13 +++++++++++++ .github/workflows/renew.yaml | 5 +---- Makefile | 10 +--------- README.md | 2 +- composer.json | 2 +- psalm-baseline.xml | 2 +- 10 files changed, 22 insertions(+), 32 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 43800c8..e87531d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -10,7 +10,7 @@ For details, take a look at the following workflow configuration files: - [`workflows/renew.yaml`](workflows/renew.yaml) - [`workflows/triage.yaml`](workflows/triage.yaml) -## Backward-compatibility Analysis +## Backward-Compatibility Analysis We use [`roave/backward-compatibility-check`](https://github.com/Roave/BackwardCompatibilityCheck) to prevent breaking backwards-compatibility. 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 4b5e070..176422a 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: ":alarm_clock: Provides a simple abstraction of a clock." + description: "⏰ Provides a composer package with abstractions of a clock." enable_automated_security_fixes: true enable_vulnerability_alerts: true has_discussions: false diff --git a/.github/workflows/integrate.yaml b/.github/workflows/integrate.yaml index 0582d4b..5c75840 100644 --- a/.github/workflows/integrate.yaml +++ b/.github/workflows/integrate.yaml @@ -40,9 +40,6 @@ jobs: - name: "Set up problem matchers for PHP" run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\"" - - name: "Set up problem matchers for phpunit/phpunit" - run: "echo \"::add-matcher::${{ runner.tool_cache }}/phpunit.json\"" - - name: "Validate composer.json and composer.lock" run: "composer validate --ansi --strict" @@ -182,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: @@ -195,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" @@ -352,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: @@ -464,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..adf3936 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 55e372d..28cb943 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/README.md b/README.md index 853c2c8..b8e4797 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ [![Total Downloads](https://poser.pugx.org/ergebnis/clock/downloads)](https://packagist.org/packages/ergebnis/clock) [![Monthly Downloads](http://poser.pugx.org/ergebnis/clock/d/monthly)](https://packagist.org/packages/ergebnis/clock) -This project provides a [`composer`](https://getcomposer.org) package with a simple abstraction of a clock, following the suggestion by [Martin Fowler](https://martinfowler.com/bliki/ClockWrapper.html), and compatible with [PSR-20](https://www.php-fig.org/psr/psr-20/). +This project provides a [`composer`](https://getcomposer.org) package with a abstractions of a clock, following the suggestion by [Martin Fowler](https://martinfowler.com/bliki/ClockWrapper.html), and compatible with [PSR-20](https://www.php-fig.org/psr/psr-20/). ## Installation diff --git a/composer.json b/composer.json index 97a8205..ac1ec90 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "ergebnis/clock", - "description": "Provides a simple abstraction of a clock.", + "description": "Provides abstractions of a clock.", "license": "MIT", "type": "library", "keywords": [ diff --git a/psalm-baseline.xml b/psalm-baseline.xml index d229bf8..eb79571 100644 --- a/psalm-baseline.xml +++ b/psalm-baseline.xml @@ -1,2 +1,2 @@ - +