Skip to content

Commit e707402

Browse files
authored
Update workflow README with optional variables
Added optional parameters for Node.js setup and theme compilation script in the workflow README.
1 parent f2a84d0 commit e707402

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

.github/workflows/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,9 @@ Configure these in **Settings** → **Secrets and variables** → **Actions**
5959
Configure these in **Settings****Secrets and variables****Actions****Variables**:
6060

6161
| Variable Name | Description | Example |
62-
|----------------------------|------------------------------------------------------------------------------|---------|
62+
|----------------------------|--------------------------------------------------------------------------------------------------------|----------------------|
6363
| `PROD_URL` | Production website URL | https://example.org |
6464
| `PROD_PHP_VERSION` | PHP version to be used on the production server | `8.3` |
65-
| `ENABLE_NODEJS` | Flag to enable Node.js setup during workflow execution. When `true`, `actions/setup-node` is executed. | `true`/`false` |
66-
| `NODE_VERSION_FILE` | Disk path to the Node.js version (e.g. `.nvmrc`, `.node-version`) | `.nvmrc` |
67-
| `COMPILE_THEME_SCRIPT` | Disk path to the theme compilation script executed during the deployments (e.g. `scripts/compile-theme.sh`). If empty, the compile step is skipped. | |
6865
| `PROD_PROJECT_DIR` | Disk path to the website symlink on the production server | `/var/www/html/example.org` |
6966
| `PROD_ARTIFACTS_DIR` | Disk path to the artifacts directory (where actual release artifacts) on the production server | /var/www/artifacts/example.org |
7067
| `PROD_SETTINGS_FILE ` | Disk path to the `settings.local.php` on the production server | `/var/www/config/example.org/settings.local.php` |
@@ -73,6 +70,9 @@ Configure these in **Settings** → **Secrets and variables** → **Actions**
7370
| `PROD_LOCAL_SERVICES_FILE` | (Optional) Disk path to the local services file on the production server | `/var/www/config/example.org/services.local.yml` |
7471
| `RETAIN_RELEASES` | (Optional) Number of releases to retain on the production server | 5 |
7572
| `RUNNER_LABEL` | (Optional) Label of the runner to be used for deployment | `drupal-runner-v2` |
73+
| `ENABLE_NODEJS` | (Optional) Flag to enable Node.js setup during workflow execution. When `true`, `actions/setup-node` is executed. | `true`/`false` |
74+
| `NODE_VERSION_FILE` | (Optional) Disk path to the Node.js version (e.g. `.nvmrc`, `.node-version`) | `.nvmrc` |
75+
| `COMPILE_THEME_SCRIPT` | (Optional) Disk path to the theme compilation script executed during the deployments - [see](https://github.com/eaudeweb/iucn.org/blob/main/.github/workflows/deploy-dev.yml#L31). If empty, the compile step is skipped. | `scripts/compile-theme.sh` |
7676

7777
> **Important**: Same variables and secrets are needed for the test environment workflows, prefixed with `TEST_` instead of `PROD_`.
7878

0 commit comments

Comments
 (0)