GH Actions: add automation for generating output examples for the wiki #20
Conversation
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
As this repo now contains a shell script to find & replace placeholders for output snippets in the wiki files with real output, let's also run a minimal QA check on the code of the shell script. Refs: * https://github.com/koalaman/shellcheck * https://github.com/koalaman/shellcheck/wiki
|
Thank you for your PR. Please review the resulting final markdown files via the created artifact. N.B.: the above link will automatically be updated when this PR is updated. |
jrfnl
changed the title
|
Note: this PR needs to be squash-merged. |
|
Note: once this PR has been merged, a follow-up PR will be pulled to the PHPCS repo to set up the triggering of a rebuild on releases. |
fredden
approved these changes
Jul 15, 2025
jrfnl
deleted the
wiki/ghactions-add-automation-for-generating-output-examples
branch
jrfnl
added
Type: other documentation improvement
and removed
Type: document new PHPCS feature
labels
|
Follow-up PR to the main PHPCS repo has been pulled: PHPCSStandards/PHP_CodeSniffer#1163 |
This was referenced Jul 17, 2025
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
GH Actions: prepare the workflow for auto-generating output snippets
Run phpcs/phpcbf commands to auto-generate output blocks
GH Actions/basic QA: add shellcheck job
As this repo now contains a shell script to find & replace placeholders for output snippets in the wiki files with real output, let's also run a minimal QA check on the code of the shell script.
Refs: