From e409ce17b28fc31faa630ea9bc1b911794a35295 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A9sz=C3=A1ros=20R=C3=B3bert?= Date: Thu, 5 Sep 2024 11:37:14 +0300 Subject: [PATCH] Remove info about PACKAGE_MANAGER from the docs after merge --- docs/archive-creation.md | 1 - docs/assets-compilation.md | 17 ++++++++--------- docs/build-and-push-assets.md | 1 - docs/js.md | 11 +++++------ docs/wp-scripts.md | 21 ++++++++++----------- 5 files changed, 23 insertions(+), 28 deletions(-) diff --git a/docs/archive-creation.md b/docs/archive-creation.md index 38e677f8..0e8b1b80 100644 --- a/docs/archive-creation.md +++ b/docs/archive-creation.md @@ -48,7 +48,6 @@ jobs: | `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`) | | `COMPOSER_ARGS` | `'--no-dev --no-scripts --prefer-dist --optimize-autoloader'` | Set of arguments passed to Composer when gathering production dependencies | | `PHP_VERSION` | `'8.0'` | PHP version to use when gathering production dependencies | | `PHP_VERSION_BUILD` | `'8.0'` | PHP version to use when executing build tools | diff --git a/docs/assets-compilation.md b/docs/assets-compilation.md index bee430b4..a2534413 100644 --- a/docs/assets-compilation.md +++ b/docs/assets-compilation.md @@ -21,15 +21,14 @@ 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 | +| `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 db27f5df..a86dc1a0 100644 --- a/docs/build-and-push-assets.md +++ b/docs/build-and-push-assets.md @@ -103,7 +103,6 @@ the workflow. | `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 | diff --git a/docs/js.md b/docs/js.md index 67cadb43..b8feb8f2 100644 --- a/docs/js.md +++ b/docs/js.md @@ -20,12 +20,11 @@ jobs: #### Inputs -| Name | Default | Description | -|-----------------------|----------------------------------------------------|-----------------------------------------------------------------------------------| -| `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`) | +| Name | Default | Description | +|-----------------------|----------------------------------------------------|-----------------------------------------------------------| +| `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 | **Note**: The default `github-actions` reporter requires Jest 28 or higher. diff --git a/docs/wp-scripts.md b/docs/wp-scripts.md index 16404fc5..31aa3b11 100644 --- a/docs/wp-scripts.md +++ b/docs/wp-scripts.md @@ -22,17 +22,16 @@ 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 | +| `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`