Making reusable-regenerate-readme GitHub-y #53
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -9,10 +9,9 @@ concurrency: | |||||||
| group: ${{ github.workflow }}-${{ github.ref }} | ||||||||
| cancel-in-progress: true | ||||||||
|
|
||||||||
| jobs: | ||||||||
|
|
||||||||
| regenerate-readme: | ||||||||
| name: Regenerate README.md file | ||||||||
| runs-on: ubuntu-latest | ||||||||
| if: ${{ github.repository_owner == 'wp-cli' && ! contains(fromJson('[".github", "wp-cli", "wp-cli-bundle", "wp-super-cache-cli", "php-cli-tools", "wp-config-transformer", "wp-cli.github.com"]'), github.event.repository.name) }} | ||||||||
|
|
@@ -21,51 +20,55 @@ jobs: | |||||||
| uses: actions/checkout@v3 | ||||||||
|
|
||||||||
| - name: Set up PHP envirnoment | ||||||||
|
There was a problem hiding this comment. Corrected spelling of 'envirnoment' to 'environment'.
Suggested change
|
||||||||
| env: | ||||||||
| COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||||||||
| uses: shivammathur/setup-php@v2 | ||||||||
| with: | ||||||||
| php-version: "7.4" | ||||||||
|
Comment on lines
-24
to
+27
Author
There was a problem hiding this comment. Put things in chronological order. |
||||||||
|
|
||||||||
| - name: Check existence of composer.json file | ||||||||
| id: check_composer_file | ||||||||
| uses: andstor/file-existence-action@v2 | ||||||||
| with: | ||||||||
| files: composer.json | ||||||||
|
|
||||||||
| - name: Install Composer dependencies & cache dependencies | ||||||||
| if: ${{ steps.check_composer_file.outputs.files_exists == 'true' }} | ||||||||
| env: | ||||||||
| COMPOSER_ROOT_VERSION: dev-${{ github.event.repository.default_branch }} | ||||||||
| uses: ramsey/composer-install@v2 | ||||||||
| with: | ||||||||
| # Bust the cache at least once a month - output format: YYYY-MM. | ||||||||
| custom-cache-suffix: | | ||||||||
| $(date --utc "+%Y-%m") | ||||||||
|
Author
There was a problem hiding this comment. Protect shell scripts. Use long options.
Comment on lines
+42
to
+43
There was a problem hiding this comment. The multi-line string format will introduce unwanted leading whitespace. The command substitution
Suggested change
|
||||||||
|
|
||||||||
| - name: Configure git user | ||||||||
| run: | | ||||||||
| git config --global user.email "alain.schlesser@gmail.com" | ||||||||
| git config --global user.name "Alain Schlesser" | ||||||||
|
|
||||||||
| - name: Check if remote branch exists | ||||||||
| id: check_remote_branch | ||||||||
| run: > | ||||||||
| echo "exists=$(git ls-remote --exit-code --heads origin regenerate-readme &>/dev/null | ||||||||
| && echo "true" || echo "false")" >>"${GITHUB_OUTPUT}" | ||||||||
|
|
||||||||
|
There was a problem hiding this comment. Remove trailing whitespace after the step definition.
Suggested change
|
||||||||
| - name: Create branch to base pull request on | ||||||||
| if: ${{ steps.check_remote_branch.outputs.exists == 'false' }} | ||||||||
| run: | | ||||||||
| git checkout -b regenerate-readme | ||||||||
|
|
||||||||
| - name: Fetch existing branch to add commits to | ||||||||
| if: ${{ steps.check_remote_branch.outputs.exists == 'true' }} | ||||||||
| run: | | ||||||||
| git fetch --all --prune | ||||||||
| git checkout regenerate-readme | ||||||||
| git pull --no-rebase | ||||||||
|
|
||||||||
| - name: Install WP-CLI nightly | ||||||||
| run: | | ||||||||
| curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli-nightly.phar | ||||||||
| sudo mv --verbose wp-cli-nightly.phar /usr/local/bin/wp | ||||||||
| sudo chmod +x /usr/local/bin/wp | ||||||||
|
|
||||||||
| - name: Regenerate README.md file | ||||||||
|
|
@@ -74,25 +77,31 @@ jobs: | |||||||
| wp scaffold package-readme --branch=${{ github.event.repository.default_branch }} --force . | ||||||||
|
|
||||||||
| - name: Check if there are changes | ||||||||
| id: check_changes | ||||||||
| run: > | ||||||||
| echo "detected=$(test -n "$(git status --porcelain 2>/dev/null)" | ||||||||
| && echo "true" || echo "false")" >>"${GITHUB_OUTPUT}" | ||||||||
|
|
||||||||
| - name: Commit changes | ||||||||
| if: ${{ steps.check_changes.outputs.detected == 'true' }} | ||||||||
| run: | | ||||||||
| git add README.md | ||||||||
| git commit -m "Regenerate README file - $(date +'%Y-%m-%d')" | ||||||||
| git push origin regenerate-readme | ||||||||
|
|
||||||||
| - name: Create pull request | ||||||||
| if: > | ||||||||
| ${{ steps.check_changes.outputs.detected == 'true' | ||||||||
| && steps.check_remote_branch.outputs.exists == 'false' }} | ||||||||
| uses: repo-sync/pull-request@v2 | ||||||||
| with: | ||||||||
| source_branch: regenerate-readme | ||||||||
| destination_branch: ${{ github.event.repository.default_branch }} | ||||||||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||||||||
| pr_title: Regenerate README file | ||||||||
| pr_body: | | ||||||||
| **This is an automated pull-request** | ||||||||
|
|
||||||||
| Refreshes the `README.md` file with the latest changes to the docblocks in the source code. | ||||||||
| pr_reviewer: schlessera | ||||||||
| pr_label: scope:documentation | ||||||||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -11,12 +11,7 @@ concurrency: | |||||||
|
|
||||||||
| jobs: | ||||||||
|
|
||||||||
| has_unit_tests: | ||||||||
| runs-on: ubuntu-20.04 | ||||||||
|
|
||||||||
| steps: | ||||||||
|
|
@@ -29,8 +24,26 @@ jobs: | |||||||
| with: | ||||||||
| files: "composer.json, phpunit.xml.dist" | ||||||||
|
|
||||||||
| outputs: | ||||||||
| exists: ${{ steps.check_files.outputs.files_exists }} | ||||||||
|
|
||||||||
| unit: | ||||||||
| name: Unit tests on PHP ${{ matrix.php }} | ||||||||
| needs: | ||||||||
| - has_unit_tests | ||||||||
| if: ${{ needs.has_unit_tests.outputs.exists == 'true' }} | ||||||||
| strategy: | ||||||||
| fail-fast: false | ||||||||
| matrix: | ||||||||
| php: ['5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2'] | ||||||||
| runs-on: ubuntu-20.04 | ||||||||
|
|
||||||||
| steps: | ||||||||
| - name: Check out source code | ||||||||
| uses: actions/checkout@v3 | ||||||||
|
|
||||||||
| - name: Set up PHP environment (PHP 5.6 - 7.1) | ||||||||
| if: ${{ matrix.php < '7.2' }} | ||||||||
| uses: shivammathur/setup-php@v2 | ||||||||
| with: | ||||||||
| php-version: '${{ matrix.php }}' | ||||||||
|
|
@@ -41,35 +54,52 @@ jobs: | |||||||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||||||||
|
|
||||||||
| - name: Set up PHP environment (PHP 7.2+) | ||||||||
| if: ${{ matrix.php >= '7.2' }} | ||||||||
| env: | ||||||||
| COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||||||||
| uses: shivammathur/setup-php@v2 | ||||||||
| with: | ||||||||
| php-version: '${{ matrix.php }}' | ||||||||
| coverage: none | ||||||||
| tools: composer,cs2pr | ||||||||
|
|
||||||||
| - name: Install Composer dependencies & cache dependencies | ||||||||
| env: | ||||||||
| COMPOSER_ROOT_VERSION: dev-${{ github.event.repository.default_branch }} | ||||||||
| uses: "ramsey/composer-install@v2" | ||||||||
| with: | ||||||||
| # Bust the cache at least once a month - output format: YYYY-MM. | ||||||||
| custom-cache-suffix: | | ||||||||
| $(date -u "+%Y-%m") | ||||||||
|
Comment on lines
+72
to
+73
There was a problem hiding this comment. The multi-line string format will introduce unwanted leading whitespace. The command substitution
Suggested change
|
||||||||
|
|
||||||||
| - name: Setup problem matcher to provide annotations for PHPUnit | ||||||||
| run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" | ||||||||
|
|
||||||||
| - name: Run PHPUnit | ||||||||
| run: composer phpunit | ||||||||
| continue-on-error: ${{ matrix.php == '8.2' }} | ||||||||
|
|
||||||||
| has_functional_tests: | ||||||||
| runs-on: ubuntu-20.04 | ||||||||
|
|
||||||||
| steps: | ||||||||
| - name: Check out source code | ||||||||
| uses: actions/checkout@v3 | ||||||||
|
|
||||||||
| - name: Check existence of composer.json & behat.yml files | ||||||||
| id: check_files | ||||||||
| uses: andstor/file-existence-action@v2 | ||||||||
| with: | ||||||||
| files: "composer.json, behat.yml" | ||||||||
|
|
||||||||
| outputs: | ||||||||
| exists: ${{ steps.check_files.outputs.files_exists }} | ||||||||
|
|
||||||||
| functional: | ||||||||
| name: Functional - WP ${{ matrix.wp }} on PHP ${{ matrix.php }} with MySQL ${{ matrix.mysql }} | ||||||||
| needs: | ||||||||
| - has_functional_tests | ||||||||
| if: ${{ needs.has_functional_tests.outputs.exists == 'true' }} | ||||||||
| strategy: | ||||||||
| fail-fast: false | ||||||||
| matrix: | ||||||||
|
|
@@ -114,55 +144,45 @@ jobs: | |||||||
| image: mysql:${{ matrix.mysql }} | ||||||||
| ports: | ||||||||
| - 3306 | ||||||||
| options: | | ||||||||
| --health-cmd="mysqladmin ping" --health-interval=15s --health-timeout=10s --health-retries=5 -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=wp_cli_test --entrypoint sh mysql:${{ matrix.mysql }} -c "exec docker-entrypoint.sh mysqld --default-authentication-plugin=mysql_native_password" | ||||||||
|
Comment on lines
+147
to
+148
There was a problem hiding this comment. The multi-line string format will introduce a leading newline and indentation whitespace that will break the docker options parsing. Docker container options must be a single-line string without leading/trailing whitespace. Keep this as a single-line value.
Suggested change
|
||||||||
|
|
||||||||
| steps: | ||||||||
| - name: Check out source code | ||||||||
| uses: actions/checkout@v3 | ||||||||
|
|
||||||||
| - name: Install Ghostscript | ||||||||
| run: | | ||||||||
| sudo apt-get update | ||||||||
| sudo apt-get install -y ghostscript | ||||||||
|
|
||||||||
| - name: Set up PHP environment | ||||||||
| env: | ||||||||
| COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||||||||
| uses: shivammathur/setup-php@v2 | ||||||||
| with: | ||||||||
| php-version: '${{ matrix.php }}' | ||||||||
| extensions: gd, imagick, mysql, zip | ||||||||
| coverage: none | ||||||||
| tools: composer | ||||||||
|
|
||||||||
| - name: Change ImageMagick policy to allow pdf->png conversion. | ||||||||
| run: | | ||||||||
| sudo sed -i 's/^.*policy.*coder.*none.*PDF.*//' /etc/ImageMagick-6/policy.xml | ||||||||
|
|
||||||||
| - name: Install Composer dependencies & cache dependencies | ||||||||
| env: | ||||||||
| COMPOSER_ROOT_VERSION: dev-${{ github.event.repository.default_branch }} | ||||||||
| uses: "ramsey/composer-install@v2" | ||||||||
| with: | ||||||||
| # Bust the cache at least once a month - output format: YYYY-MM. | ||||||||
| custom-cache-suffix: | | ||||||||
| $(date -u "+%Y-%m") | ||||||||
|
Comment on lines
+179
to
+180
There was a problem hiding this comment. The multi-line string format will introduce unwanted leading whitespace. The command substitution
Suggested change
|
||||||||
|
|
||||||||
| - name: Start MySQL server | ||||||||
| run: sudo systemctl start mysql | ||||||||
|
|
||||||||
| - name: Configure DB environment | ||||||||
| run: | | ||||||||
| echo "MYSQL_HOST=127.0.0.1" >> $GITHUB_ENV | ||||||||
| echo "MYSQL_TCP_PORT=${{ job.services.mysql.ports['3306'] }}" >> $GITHUB_ENV | ||||||||
|
|
@@ -174,18 +194,15 @@ jobs: | |||||||
| echo "WP_CLI_TEST_DBHOST=127.0.0.1:${{ job.services.mysql.ports['3306'] }}" >> $GITHUB_ENV | ||||||||
|
|
||||||||
| - name: Prepare test database | ||||||||
| run: composer prepare-tests | ||||||||
|
|
||||||||
| - name: Check Behat environment | ||||||||
| env: | ||||||||
| WP_VERSION: '${{ matrix.wp }}' | ||||||||
| run: WP_CLI_TEST_DEBUG_BEHAT_ENV=1 composer behat | ||||||||
|
|
||||||||
| - name: Run Behat | ||||||||
| env: | ||||||||
| WP_VERSION: '${{ matrix.wp }}' | ||||||||
| run: composer behat || composer behat-rerun | ||||||||
| continue-on-error: ${{ matrix.php == '8.2' }} | ||||||||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This may get emotional.
👨🏻🎨