From b7ac358a01935af40445355bf6f13ec29c2d8992 Mon Sep 17 00:00:00 2001 From: meszarosrob Date: Wed, 4 Sep 2024 16:38:09 +0300 Subject: [PATCH] Remove info about PACKAGE_MANAGER from the docs --- docs/archive-creation.md | 1 - docs/assets-compilation.md | 1 - docs/build-and-push-assets.md | 29 ++++++++++++++--------------- docs/js.md | 1 - docs/wp-scripts.md | 1 - 5 files changed, 14 insertions(+), 19 deletions(-) diff --git a/docs/archive-creation.md b/docs/archive-creation.md index 02341788..e4c294ec 100644 --- a/docs/archive-creation.md +++ b/docs/archive-creation.md @@ -46,7 +46,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` | `"npm"` | 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 a6427b7f..6741a4cf 100644 --- a/docs/assets-compilation.md +++ b/docs/assets-compilation.md @@ -25,7 +25,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` | `npm` | 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 | diff --git a/docs/build-and-push-assets.md b/docs/build-and-push-assets.md index 73968087..de78d736 100644 --- a/docs/build-and-push-assets.md +++ b/docs/build-and-push-assets.md @@ -94,21 +94,20 @@ This is not the simplest possible example, but it showcases all the recommendati ### 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` | `npm` | 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 | +| 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 | +| `WORKING_DIRECTORY` | `'./'` | Working directory path | +| `COMPILE_SCRIPT_PROD` | `'build'` | Script added to `npm run` to build production assets | +| `COMPILE_SCRIPT_DEV` | `'build:dev'` | Script added to `npm run` 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/js.md b/docs/js.md index 7541cb55..73f911b1 100644 --- a/docs/js.md +++ b/docs/js.md @@ -25,7 +25,6 @@ jobs: | `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` | `npm` | Package manager with which the dependencies should be installed (`npm` or `yarn`) | **Note**: The default `github-actions` reporter requires Jest 28 or higher. diff --git a/docs/wp-scripts.md b/docs/wp-scripts.md index f9a10b29..123bb83d 100644 --- a/docs/wp-scripts.md +++ b/docs/wp-scripts.md @@ -26,7 +26,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` | `npm` | 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` |