polyci 0.1.6 → 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.
Files changed (2) hide show
  1. package/package.json +34 -34
  2. package/readme.md +73 -54
package/package.json CHANGED
@@ -1,34 +1,34 @@
1
- {
2
- "name": "polyci",
3
- "description": "Monorepo CI/CD utilities.",
4
- "version": "0.1.6",
5
- "type": "module",
6
- "private": false,
7
- "author": "Alexander Tsarev",
8
- "license": "MIT",
9
- "main": "./dist/main.js",
10
- "bin": {
11
- "polyci": "dist/cli.js"
12
- },
13
- "files": [
14
- "dist",
15
- "readme.md"
16
- ],
17
- "publishConfig": {
18
- "access": "public"
19
- },
20
- "scripts": {
21
- "build": "tsc",
22
- "dev": "tsx main.ts"
23
- },
24
- "dependencies": {
25
- "commander": "^14.0.3",
26
- "pino": "^10.3.1",
27
- "pino-pretty": "^13.1.3"
28
- },
29
- "devDependencies": {
30
- "@types/node": "^25.3.3",
31
- "tsx": "^4.21.0",
32
- "typescript": "^5.9.3"
33
- }
34
- }
1
+ {
2
+ "name": "polyci",
3
+ "description": "Monorepo CI/CD utilities.",
4
+ "version": "0.1.8",
5
+ "type": "module",
6
+ "private": false,
7
+ "author": "Alexander Tsarev",
8
+ "license": "MIT",
9
+ "main": "./dist/main.js",
10
+ "bin": {
11
+ "polyci": "dist/cli.js"
12
+ },
13
+ "files": [
14
+ "dist",
15
+ "readme.md"
16
+ ],
17
+ "publishConfig": {
18
+ "access": "public"
19
+ },
20
+ "scripts": {
21
+ "build": "tsc",
22
+ "dev": "tsx main.ts"
23
+ },
24
+ "dependencies": {
25
+ "commander": "^14.0.3",
26
+ "pino": "^10.3.1",
27
+ "pino-pretty": "^13.1.3"
28
+ },
29
+ "devDependencies": {
30
+ "@types/node": "^25.3.3",
31
+ "tsx": "^4.21.0",
32
+ "typescript": "^5.9.3"
33
+ }
34
+ }
package/readme.md CHANGED
@@ -1,54 +1,73 @@
1
- # polyci
2
-
3
- Generates GitLab CI pipelines for monorepos. Discovers modules under a root directory, creates per-module build, test, release, publish, and deploy jobs, and wires them with conventional-commit-based versioning via semalease.
4
-
5
- ## Installation
6
-
7
- ```bash
8
- npm install
9
- npm run build
10
- ```
11
-
12
- Or use via `npx polyci` when the package is published.
13
-
14
- ## Usage
15
-
16
- ```bash
17
- npx polyci [output] [options]
18
- ```
19
-
20
- **Example** (typical GitLab CI setup):
21
-
22
- ```bash
23
- npx polyci --modules-root modules polyci-pipeline.yml
24
- ```
25
-
26
- **Options:**
27
-
28
- | Option | Description | Default |
29
- |--------|-------------|---------|
30
- | `-o, --output <path>` | Output pipeline file path | — |
31
- | `--modules-root <path>` | Root directory to scan for modules | `./modules` |
32
- | `--main-branch <name>` | Primary branch for release tagging | `main` |
33
- | `--version-template <template>` | Version template for main branch; placeholders: `{version}`, `{branch}`, `{increment}` | `{version}` |
34
- | `--branch-version-template <template>` | Version template for non-main branches | `{version}-{branch}-{increment}` |
35
- | `--tag-template <template>` | Tag template; placeholders: `{module}`, `{version}` | `{module}-v{version}` |
36
- | `--tag-pattern <pattern>` | Tag regex for main branch (passed to semalease) | `^$PLI_MODULE_NAME-v(?<version>...)` |
37
- | `--branch-tag-pattern <pattern>` | Tag regex for non-main branches (with `?<increment>`) | — |
38
- | `--cwd <path>` | Working directory | current directory |
39
-
40
- ## Description
41
-
42
- If there is no new version, publish and deploy finish successfuly doing nothing.
43
-
44
- ## Requirements
45
-
46
- - **POLYCI_TOKEN** — GitLab OAuth token for pushing tags; must be defined in GitLab CI/CD variables and available to jobs that run the release stage.
47
- - **Module build** — Each module must support `npm run build` and produce output in `./dist`.
48
-
49
- For **docker-service** deploy type: a Docker host with Traefik 3.
50
-
51
- ## Recommendations
52
-
53
- - **Do not modify the built-in module types** (`node-vite`, `node-express`, `npm-package`). Copy and customize a new type under `ci/` instead.
54
- - **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.
1
+ # polyci
2
+
3
+ Generates GitLab CI pipelines for monorepos. Discovers modules under a root directory, creates per-module build, test, release, publish, and deploy jobs, and wires them with conventional-commit-based versioning via semalease.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install
9
+ npm run build
10
+ ```
11
+
12
+ Or use via `npx polyci` when the package is published.
13
+
14
+ ## Usage
15
+
16
+ ```bash
17
+ npx polyci [output] [options]
18
+ ```
19
+
20
+ **Example** (typical GitLab CI setup):
21
+
22
+ ```bash
23
+ npx polyci --modules-root modules polyci-pipeline.yml
24
+ ```
25
+
26
+ **Options:**
27
+
28
+ | Option | Description | Default |
29
+ |--------|-------------|---------|
30
+ | `-o, --output <path>` | Output pipeline file path | — |
31
+ | `--modules-root <path>` | Root directory to scan for modules | `./modules` |
32
+ | `--main-branch <name>` | Primary branch for release tagging | `main` |
33
+ | `--version-template <template>` | Version template for main branch; placeholders: `{version}`, `{branch}`, `{increment}` | `{version}` |
34
+ | `--branch-version-template <template>` | Version template for non-main branches | `{version}-{branch}-{increment}` |
35
+ | `--tag-template <template>` | Tag template; placeholders: `{module}`, `{version}` | `{module}-v{version}` |
36
+ | `--tag-pattern <pattern>` | Tag regex for main branch (passed to semalease) | `^$PLI_MODULE_NAME-v(?<version>...)` |
37
+ | `--branch-tag-pattern <pattern>` | Tag regex for non-main branches (with `?<increment>`) | — |
38
+ | `--cwd <path>` | Working directory | current directory |
39
+
40
+ ## Description
41
+
42
+ If there is no new version, publish and deploy finish successfuly doing nothing.
43
+
44
+ ## Requirements
45
+
46
+ - **POLYCI_TOKEN** — GitLab OAuth token for pushing tags; must be defined in GitLab CI/CD variables and available to jobs that run the release stage.
47
+ - **Module build** — Each module must support `npm run build` and produce output in `./dist`.
48
+
49
+ For **docker-service** deploy type: a Docker host with Traefik 3.
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
+
66
+ ## Recommendations
67
+
68
+ - **Do not modify the built-in module types** (`node-vite`, `node-express`, `npm-package`). Copy and customize a new type under `ci/` instead.
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.