polyci 0.1.0 → 0.1.2

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 (3) hide show
  1. package/dist/main.js +10 -3
  2. package/package.json +1 -1
  3. package/readme.md +51 -10
package/dist/main.js CHANGED
@@ -341,7 +341,6 @@ function appendModulePublishJob(lines, module) {
341
341
  lines.push(` - changes:`);
342
342
  lines.push(` - ${module.modulePath}/**/*`);
343
343
  lines.push(` needs:`);
344
- lines.push(` - job: ${module.moduleName}-test`);
345
344
  lines.push(` - job: release`);
346
345
  lines.push(` image: $IMAGE_NODE`);
347
346
  lines.push(` script:`);
@@ -350,7 +349,11 @@ function appendModulePublishJob(lines, module) {
350
349
  lines.push(` - cd ${module.modulePath}`);
351
350
  lines.push(` - cat polyci.env`);
352
351
  lines.push(` - source polyci.env`);
353
- lines.push(` - source "ci/${module.moduleType}/publish.sh"`);
352
+ lines.push(` - if [ -n "\${PLI_MODULE_VERSION:-}" ]; then`);
353
+ lines.push(` source "ci/${module.moduleType}/publish.sh"`);
354
+ lines.push(` else`);
355
+ lines.push(` echo "No new version. Skipping publish."`);
356
+ lines.push(` fi`);
354
357
  lines.push(` artifacts:`);
355
358
  lines.push(` paths:`);
356
359
  lines.push(` - ${module.modulePath}/polyci.env`);
@@ -372,7 +375,11 @@ function appendModuleDeployJob(lines, module) {
372
375
  lines.push(` - cd ${module.modulePath}`);
373
376
  lines.push(` - cat polyci.env`);
374
377
  lines.push(` - source polyci.env`);
375
- lines.push(` - source "ci/${module.moduleType}/deploy.sh"`);
378
+ lines.push(` - if [ -n "\${PLI_MODULE_VERSION:-}" ]; then`);
379
+ lines.push(` source "ci/${module.moduleType}/deploy.sh"`);
380
+ lines.push(` else`);
381
+ lines.push(` echo "No new version. Skipping deploy."`);
382
+ lines.push(` fi`);
376
383
  lines.push(``);
377
384
  }
378
385
  function buildPipeline(modules, mainBranch, versionTemplate, branchVersionTemplate, tagTemplate, tagPattern, branchTagPattern) {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "polyci",
3
3
  "description": "Monorepo CI/CD utilities.",
4
- "version": "0.1.0",
4
+ "version": "0.1.2",
5
5
  "type": "module",
6
6
  "private": false,
7
7
  "author": "Alexander Tsarev",
package/readme.md CHANGED
@@ -1,13 +1,54 @@
1
- installation
1
+ # polyci
2
2
 
3
- usage
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
4
 
5
- recommedations
6
- do not change the provided module types and scripts. instead, copy and customise your own type.
7
- be careful changin environment in release.sh (eg install packages) as the module releases run in one job in one container.
5
+ ## Installation
8
6
 
9
- requirements
10
- POLYCI_TOKEN variable must be defined in GitLab and accessible in the jobs that match the rule in the root .gitlab-ci.yml.
11
- each module must have build script to be called via "npm run build".
12
- each module must put the build result into ./dist folder.
13
- docker service deploy needs docker host server with traefik 3.
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.