polyci 0.1.7 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/readme.md +19 -0
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -48,7 +48,26 @@ If there is no new version, publish and deploy finish successfuly doing nothing.
|
|
|
48
48
|
|
|
49
49
|
For **docker-service** deploy type: a Docker host with Traefik 3.
|
|
50
50
|
|
|
51
|
+
## PLI_ variables
|
|
52
|
+
|
|
53
|
+
Jobs receive module context via `PLI_`-prefixed variables, written to `polyci.env` and sourced between stages.
|
|
54
|
+
|
|
55
|
+
| Variable | Set by | Description |
|
|
56
|
+
|----------|--------|-------------|
|
|
57
|
+
| `PLI_MODULE_NAME` | build | Module name (directory name under modules-root) |
|
|
58
|
+
| `PLI_MODULE_PATH` | build | Path to the module directory |
|
|
59
|
+
| `PLI_MODULE_TYPE` | build | Module type (e.g. `node-vite`, `node-express`, `docker-service`) |
|
|
60
|
+
| `PLI_MODULE_VERSION` | release | Version string; set only when there is a new release |
|
|
61
|
+
| `PLI_MODULE_TAG` | release | Git tag for the module (e.g. `module-name-v1.0.0`) |
|
|
62
|
+
| `PLI_PACKAGE_NAME` | deploy scripts | `name` from `package.json` (used by node-docker deploy) |
|
|
63
|
+
| `PLI_INSTANCE_CONTAINER` | deploy scripts | `{PLI_PACKAGE_NAME}-{CI_COMMIT_BRANCH}` for docker-service |
|
|
64
|
+
| `PLI_INSTANCE_DOMAIN` | deploy scripts | Domain(s) from `package.json`; branch-prefixed for non-main |
|
|
65
|
+
|
|
51
66
|
## Recommendations
|
|
52
67
|
|
|
53
68
|
- **Do not modify the built-in module types** (`node-vite`, `node-express`, `npm-package`). Copy and customize a new type under `ci/` instead.
|
|
54
69
|
- **Avoid heavy setup in `release.sh`** — Module releases run sequentially in a single container; installing extra packages or changing the environment can slow or break the job.
|
|
70
|
+
|
|
71
|
+
## Usage
|
|
72
|
+
|
|
73
|
+
When a polyci branch is merged into main branch the latest commit is often a polyci release commit. As a result the merge itself is ignored by polyci and the main branch is not published and deployed. To avoid this, just add an ampty commit after merge before you push to the repository.
|