Skip to content

Commit

Permalink
docs: wrap all strings in quotes
Browse files Browse the repository at this point in the history
  • Loading branch information
@tyrann0us
tyrann0us committed Sep 5, 2024
1 parent a955768 commit 3fee9f1
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 39 deletions.
18 changes: 9 additions & 9 deletions docs/assets-compilation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
32 changes: 16 additions & 16 deletions docs/build-and-push-assets.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/ddev-playwright.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down
2 changes: 1 addition & 1 deletion docs/js.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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`) |
Expand Down
2 changes: 1 addition & 1 deletion docs/php.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
22 changes: 11 additions & 11 deletions docs/wp-scripts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 3fee9f1

Please sign in to comment.