Skip to content

Commit

Permalink
Remove info about PACKAGE_MANAGER from the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@meszarosrob
meszarosrob committed Sep 4, 2024
1 parent 8020b2a commit b7ac358
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 19 deletions.
1 change: 0 additions & 1 deletion docs/archive-creation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion docs/assets-compilation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
29 changes: 14 additions & 15 deletions docs/build-and-push-assets.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/js.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 0 additions & 1 deletion docs/wp-scripts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down

0 comments on commit b7ac358

Please sign in to comment.