Skip to content

feat(build-and-distribute): add NPM_BUILD_SCRIPT input to allow custom build scripts #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
luislard wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(build-and-distribute): add NPM_BUILD_SCRIPT input to allow custom build scripts #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/workflows/build-and-distribute.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ on:
default: 18
required: false
type: string
NPM_BUILD_SCRIPT:
description: The script to be used to run the build. e.g. build:dev
default: ''
required: false
type: string
NPM_REGISTRY_DOMAIN:
description: Domain of the private npm registry.
default: https://npm.pkg.github.com/
Expand Down Expand Up @@ -329,7 +334,7 @@ jobs:
${{ inputs.PRE_SCRIPT }}

- name: Compile assets
run: npm run build
run: npm run ${{ inputs.NPM_BUILD_SCRIPT || 'build' }}

- name: Run WordPress Translation Downloader
if: ${{ env.HAS_COMPOSER == 'true' }}
Expand Down
39 changes: 24 additions & 15 deletions docs/build-and-distribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,19 +111,20 @@ 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 |
| `PHP_VERSION` | `'8.2'` | PHP version with which the PHP tools are to be executed |
| `PHP_EXTENSIONS` | `''` | PHP extensions supported by shivammathur/setup-php to be installed or disabled |
| `PHP_TOOLS` | `''` | PHP tools supported by shivammathur/setup-php to be installed |
| `COMPOSER_ARGS` | `'--no-dev --prefer-dist --optimize-autoloader'` | Set of arguments passed to Composer when gathering production dependencies |
| `PACKAGE_NAME` | `''` | The name of the package (falls back to the repository name) |
| `PACKAGE_VERSION` | `''` | The new package version. If not provided, will use latest tag version with branch name as pre-release identifier |
| `PRE_SCRIPT` | `''` | Run custom shell code before creating the release archive |
| `BUILT_BRANCH_NAME` | `''` | Override the automatic build branch naming (defaults to stripping `dev/` prefix from origin branch) |
| 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 |
| `NPM_BUILD_SCRIPT` | `''` | The npm script used to compile assets (falls back to `build`). e.g. `build:dev` |
| `PHP_VERSION` | `'8.2'` | PHP version with which the PHP tools are to be executed |
| `PHP_EXTENSIONS` | `''` | PHP extensions supported by shivammathur/setup-php to be installed or disabled |
| `PHP_TOOLS` | `''` | PHP tools supported by shivammathur/setup-php to be installed |
| `COMPOSER_ARGS` | `'--no-dev --prefer-dist --optimize-autoloader'` | Set of arguments passed to Composer when gathering production dependencies |
| `PACKAGE_NAME` | `''` | The name of the package (falls back to the repository name) |
| `PACKAGE_VERSION` | `''` | The new package version. If not provided, will use latest tag version with branch name as pre-release identifier |
| `PRE_SCRIPT` | `''` | Run custom shell code before creating the release archive |
| `BUILT_BRANCH_NAME` | `''` | Override the automatic build branch naming (defaults to stripping `dev/` prefix from origin branch) |


#### A note on `BUILT_BRANCH_NAME`
Expand Down Expand Up @@ -227,12 +228,20 @@ The workflow handles version information for both plugins and themes:

### Asset Compilation

The workflow expects a `build` script in your `package.json`:
The workflow runs `npm run build` by default. Use the `NPM_BUILD_SCRIPT` input to override this — for example, to run a development build on feature branches and a production build on stable branches:

```yml
with:
NPM_BUILD_SCRIPT: ${{ (github.ref_name == 'dev/main' || github.ref_name == 'dev/beta' || github.ref_type == 'tag') && 'build' || 'build:dev' }}
```

Your `package.json` should define the corresponding scripts:

```json
{
"scripts": {
"build": "wp-scripts build"
"build": "wp-scripts build",
"build:dev": "wp-scripts build --mode=development"
}
}
```
Expand Down
Loading