From 3fee9f15f6e49b5e7ef0f22d04bf3821d328ae3b Mon Sep 17 00:00:00 2001 From: Philipp Bammes Date: Thu, 5 Sep 2024 09:17:09 +0200 Subject: [PATCH] docs: wrap all strings in quotes --- docs/assets-compilation.md | 18 +++++++++--------- docs/build-and-push-assets.md | 32 ++++++++++++++++---------------- docs/ddev-playwright.md | 2 +- docs/js.md | 2 +- docs/php.md | 2 +- docs/wp-scripts.md | 22 +++++++++++----------- 6 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/assets-compilation.md b/docs/assets-compilation.md index 9686e778..bee430b4 100644 --- a/docs/assets-compilation.md +++ b/docs/assets-compilation.md @@ -21,15 +21,15 @@ jobs: ### Inputs -| Name | Default | Description | -|-----------------------|-------------------------------|-----------------------------------------------------------------------------------| -| `NODE_OPTIONS` | `''` | Space-separated list of command-line Node options | -| `NODE_VERSION` | `18` | Node version with which the assets will be compiled | -| `NPM_REGISTRY_DOMAIN` | `https://npm.pkg.github.com/` | Domain of the private npm registry | -| `PACKAGE_MANAGER` | `'yarn'` | Package manager with which the dependencies should be installed (`npm` or `yarn`) | -| `PHP_VERSION` | `'8.0'` | PHP version with which the assets compilation is to be executed | -| `COMPOSER_ARGS` | `'--prefer-dist'` | Set of arguments passed to Composer | -| `COMPILE_ASSETS_ARGS` | `'-v --env=root'` | Set of arguments passed to Composer Asset Compiler | +| Name | Default | Description | +|-----------------------|---------------------------------|-----------------------------------------------------------------------------------| +| `NODE_OPTIONS` | `''` | Space-separated list of command-line Node options | +| `NODE_VERSION` | `18` | Node version with which the assets will be compiled | +| `NPM_REGISTRY_DOMAIN` | `'https://npm.pkg.github.com/'` | Domain of the private npm registry | +| `PACKAGE_MANAGER` | `'yarn'` | Package manager with which the dependencies should be installed (`npm` or `yarn`) | +| `PHP_VERSION` | `'8.0'` | PHP version with which the assets compilation is to be executed | +| `COMPOSER_ARGS` | `'--prefer-dist'` | Set of arguments passed to Composer | +| `COMPILE_ASSETS_ARGS` | `'-v --env=root'` | Set of arguments passed to Composer Asset Compiler | ### Secrets diff --git a/docs/build-and-push-assets.md b/docs/build-and-push-assets.md index 276e0fc2..db27f5df 100644 --- a/docs/build-and-push-assets.md +++ b/docs/build-and-push-assets.md @@ -98,22 +98,22 @@ the workflow. ### Inputs -| Name | Default | Description | -|-----------------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------| -| `NODE_OPTIONS` | `''` | Space-separated list of command-line Node options | -| `NODE_VERSION` | `18` | Node version with which the assets will be compiled | -| `NPM_REGISTRY_DOMAIN` | `https://npm.pkg.github.com/` | Domain of the private npm registry | -| `PACKAGE_MANAGER` | `'yarn'` | Package manager with which the dependencies should be installed (`npm` or `yarn`) | -| `WORKING_DIRECTORY` | `'./'` | Working directory path | -| `COMPILE_SCRIPT_PROD` | `'build'` | Script added to `npm run` or `yarn` to build production assets | -| `COMPILE_SCRIPT_DEV` | `'build:dev'` | Script added to `npm run` or `yarn` to build development assets | -| `MODE` | `''` | Mode for compiling assets (`prod` or `dev`) | -| `ASSETS_TARGET_PATHS` | `'./assets'` | Space-separated list of target directory paths for compiled assets | -| `ASSETS_TARGET_FILES` | `''` | Space-separated list of target file paths for compiled assets | -| `BUILT_BRANCH_NAME` | `''` | Sets the target branch for pushing assets on the `branch` event | -| `RELEASE_BRANCH_NAME` | `''` | On tag events, target branch where compiled assets are pushed and the tag is moved to | -| `PHP_VERSION` | `'8.0'` | PHP version with which the PHP tools are to be executed | -| `PHP_TOOLS` | `''` | PHP tools supported by [shivammathur/setup-php](https://github.com/shivammathur/setup-php#wrench-tools-support) to be installed | +| Name | Default | Description | +|-----------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| `NODE_OPTIONS` | `''` | Space-separated list of command-line Node options | +| `NODE_VERSION` | `18` | Node version with which the assets will be compiled | +| `NPM_REGISTRY_DOMAIN` | `'https://npm.pkg.github.com/'` | Domain of the private npm registry | +| `PACKAGE_MANAGER` | `'yarn'` | Package manager with which the dependencies should be installed (`npm` or `yarn`) | +| `WORKING_DIRECTORY` | `'./'` | Working directory path | +| `COMPILE_SCRIPT_PROD` | `'build'` | Script added to `npm run` or `yarn` to build production assets | +| `COMPILE_SCRIPT_DEV` | `'build:dev'` | Script added to `npm run` or `yarn` to build development assets | +| `MODE` | `''` | Mode for compiling assets (`prod` or `dev`) | +| `ASSETS_TARGET_PATHS` | `'./assets'` | Space-separated list of target directory paths for compiled assets | +| `ASSETS_TARGET_FILES` | `''` | Space-separated list of target file paths for compiled assets | +| `BUILT_BRANCH_NAME` | `''` | Sets the target branch for pushing assets on the `branch` event | +| `RELEASE_BRANCH_NAME` | `''` | On tag events, target branch where compiled assets are pushed and the tag is moved to | +| `PHP_VERSION` | `'8.0'` | PHP version with which the PHP tools are to be executed | +| `PHP_TOOLS` | `''` | PHP tools supported by [shivammathur/setup-php](https://github.com/shivammathur/setup-php#wrench-tools-support) to be installed | ## Secrets diff --git a/docs/ddev-playwright.md b/docs/ddev-playwright.md index 42f9b451..80224b31 100644 --- a/docs/ddev-playwright.md +++ b/docs/ddev-playwright.md @@ -66,7 +66,7 @@ jobs: | Name | Default | Description | |--------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `PHP_VERSION` | `''` | PHP version which will override the version set in the DDEV config | -| `NODE_VERSION` | `''` | Node version which will override the version set in the DDEV config | +| `NODE_VERSION` | - | Node version which will override the version set in the DDEV config | | `DDEV_ORCHESTRATE_CMD` | `''` | The command for setting up the DDEV website, such as `ddev orchestrate` from [inpsyde/ddev-wordpress-plugin-template](https://github.com/inpsyde/ddev-wordpress-plugin-template) | | `PLAYWRIGHT_INSTALL_CMD` | `''` | The command for installing Playwright and its deps, such as `yarn install && yarn playwright install --with-deps` or `ddev pw-install-host` from [inpsyde/ddev-wordpress-plugin-template](https://github.com/inpsyde/ddev-wordpress-plugin-template) | | `PLAYWRIGHT_RUN_CMD` | `''` | The command for running Playwright tests, such as `yarn playwright test` or `ddev pw-host test` from [inpsyde/ddev-wordpress-plugin-template](https://github.com/inpsyde/ddev-wordpress-plugin-template) | diff --git a/docs/js.md b/docs/js.md index 32f51b22..67cadb43 100644 --- a/docs/js.md +++ b/docs/js.md @@ -22,7 +22,7 @@ jobs: | Name | Default | Description | |-----------------------|----------------------------------------------------|-----------------------------------------------------------------------------------| -| `NPM_REGISTRY_DOMAIN` | `https://npm.pkg.github.com/` | Domain of the private npm registry | +| `NPM_REGISTRY_DOMAIN` | `'https://npm.pkg.github.com/'` | Domain of the private npm registry | | `NODE_VERSION` | `18` | Node version with which the unit tests are to be executed | | `JEST_ARGS` | `'--reporters=default --reporters=github-actions'` | Set of arguments passed to Jest | | `PACKAGE_MANAGER` | `'yarn'` | Package manager with which the dependencies should be installed (`npm` or `yarn`) | diff --git a/docs/php.md b/docs/php.md index 3b15d0db..35b6f8ca 100644 --- a/docs/php.md +++ b/docs/php.md @@ -189,7 +189,7 @@ jobs: | Name | Default | Description | |-------------------------|-----------------------------------------|----------------------------------------------------------------| -| `PHP_VERSION` | `"8.0"` | PHP version with which the scripts are executed | +| `PHP_VERSION` | `'8.0'` | PHP version with which the scripts are executed | | `COMPOSER_ARGS` | `'--prefer-dist'` | Set of arguments passed to Composer | | `LINT_ARGS` | `'-e php --colors --show-deprecated .'` | Set of arguments passed to PHP Parallel Lint | | `COMPOSER_DEPS_INSTALL` | `false` | Whether or not to install Composer dependencies before linting | diff --git a/docs/wp-scripts.md b/docs/wp-scripts.md index 43b06120..e07e96ac 100644 --- a/docs/wp-scripts.md +++ b/docs/wp-scripts.md @@ -22,17 +22,17 @@ jobs: #### Inputs -| Name | Default | Description | -|-------------------------|--------------------------------|-----------------------------------------------------------------------------------| -| `NODE_OPTIONS` | `''` | Space-separated list of command-line Node options | -| `NODE_VERSION` | `18` | Node version with which the assets will be compiled | -| `NPM_REGISTRY_DOMAIN` | `https://npm.pkg.github.com/` | Domain of the private npm registry | -| `PACKAGE_MANAGER` | `'yarn'` | Package manager with which the dependencies should be installed (`npm` or `yarn`) | -| `LINT_TOOLS` | `'["js", "style", "md-docs"]'` | Array of checks to be executed by @wordpress/scripts | -| `ESLINT_ARGS` | `''` | Set of arguments passed to `wp-script lint-js` | -| `STYLELINT_ARGS` | `''` | Set of arguments passed to `wp-script lint-style` | -| `MARKDOWNLINT_ARGS` | `''` | Set of arguments passed to `wp-script lint-md-docs` | -| `PACKAGE_JSONLINT_ARGS` | `''` | Set of arguments passed to `wp-scripts lint-pkg-json` | +| Name | Default | Description | +|-------------------------|----------------------------------|-----------------------------------------------------------------------------------| +| `NODE_OPTIONS` | `''` | Space-separated list of command-line Node options | +| `NODE_VERSION` | `18` | Node version with which the assets will be compiled | +| `NPM_REGISTRY_DOMAIN` | `'https://npm.pkg.github.com/'` | Domain of the private npm registry | +| `PACKAGE_MANAGER` | `'yarn'` | Package manager with which the dependencies should be installed (`npm` or `yarn`) | +| `LINT_TOOLS` | `'["js", "style", "md-docs"]'` | Array of checks to be executed by @wordpress/scripts | +| `ESLINT_ARGS` | `''` | Set of arguments passed to `wp-script lint-js` | +| `STYLELINT_ARGS` | `''` | Set of arguments passed to `wp-script lint-style` | +| `MARKDOWNLINT_ARGS` | `''` | Set of arguments passed to `wp-script lint-md-docs` | +| `PACKAGE_JSONLINT_ARGS` | `''` | Set of arguments passed to `wp-scripts lint-pkg-json` | > :information_source: **By default, "pkg-json" is not part of the `LINT_TOOLS` input.** > :information_source: **The `--formatter github` flag is hardcoded into the `wp-script lint-style`