4.1.31

.gitea/workflows/default_tags.yaml

@@ -103,6 +103,6 @@ jobs:
       run: |
         npmci node install stable
         npmci npm install
-        pnpm install -g @gitzone/tsdoc
+        pnpm install -g @git.zone/tsdoc
         npmci command tsdoc
       continue-on-error: true

cli.ts.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 process.env.CLI_CALL = 'true';
 
-import * as tsrun from '@gitzone/tsrun';
+import * as tsrun from '@git.zone/tsrun';
 tsrun.runPath('./cli.child.js', import.meta.url);

npmextra.json

@@ -12,11 +12,28 @@
     "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "shipzone",
+      "gitscope": "ship.zone",
       "gitrepo": "npmci",
-      "description": "node and docker in gitlab ci on steroids",
+      "description": "A tool to streamline Node.js and Docker workflows within CI environments, particularly GitLab CI, providing various CI/CD utilities.",
-      "npmPackagename": "@shipzone/npmci",
+      "npmPackagename": "@ship.zone/npmci",
-      "license": "MIT"
+      "license": "MIT",
+      "keywords": [
+        "Node.js",
+        "Docker",
+        "GitLab CI",
+        "GitHub CI",
+        "Gitea CI",
+        "CI/CD",
+        "automation",
+        "npm",
+        "TypeScript",
+        "cloud",
+        "SSH",
+        "registry",
+        "container management",
+        "continuous integration",
+        "continuous deployment"
+      ]
     }
   }
 }

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "@shipzone/npmci",
+  "name": "@ship.zone/npmci",
-  "version": "4.1.15",
+  "version": "4.1.31",
   "private": false,
-  "description": "node and docker in gitlab ci on steroids",
+  "description": "A tool to streamline Node.js and Docker workflows within CI environments, particularly GitLab CI, providing various CI/CD utilities.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
@@ -26,35 +26,35 @@
   },
   "homepage": "https://gitlab.com/gitzone/npmci#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.66",
+    "@git.zone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.2.42",
+    "@git.zone/tsrun": "^1.2.44",
-    "@gitzone/tstest": "^1.0.74",
+    "@git.zone/tstest": "^1.0.77",
-    "@pushrocks/tapbundle": "^5.0.8",
+    "@push.rocks/tapbundle": "^5.0.15",
-    "@types/node": "^20.3.1"
+    "@types/node": "^20.5.4"
   },
   "dependencies": {
-    "@apiglobal/typedrequest": "^2.0.12",
+    "@api.global/typedrequest": "^3.0.1",
-    "@pushrocks/lik": "^6.0.2",
+    "@push.rocks/lik": "^6.0.5",
-    "@pushrocks/npmextra": "^3.0.9",
+    "@push.rocks/npmextra": "^4.0.0",
-    "@pushrocks/projectinfo": "^5.0.1",
+    "@push.rocks/projectinfo": "^5.0.2",
-    "@pushrocks/qenv": "^5.0.2",
+    "@push.rocks/qenv": "^6.0.2",
-    "@pushrocks/smartanalytics": "^2.0.15",
+    "@push.rocks/smartanalytics": "^2.0.15",
-    "@pushrocks/smartcli": "^4.0.6",
+    "@push.rocks/smartcli": "^4.0.8",
-    "@pushrocks/smartdelay": "^3.0.1",
+    "@push.rocks/smartdelay": "^3.0.5",
-    "@pushrocks/smartenv": "^5.0.5",
+    "@push.rocks/smartenv": "^5.0.5",
-    "@pushrocks/smartfile": "^10.0.25",
+    "@push.rocks/smartfile": "^10.0.30",
-    "@pushrocks/smartgit": "^3.0.0",
+    "@push.rocks/smartgit": "^3.0.1",
-    "@pushrocks/smartlog": "^3.0.2",
+    "@push.rocks/smartlog": "^3.0.3",
-    "@pushrocks/smartlog-destination-local": "^9.0.0",
+    "@push.rocks/smartlog-destination-local": "^9.0.0",
-    "@pushrocks/smartparam": "^1.1.6",
+    "@push.rocks/smartobject": "^1.0.12",
-    "@pushrocks/smartpath": "^5.0.5",
+    "@push.rocks/smartpath": "^5.0.11",
-    "@pushrocks/smartpromise": "^4.0.2",
+    "@push.rocks/smartpromise": "^4.0.2",
-    "@pushrocks/smartrequest": "^2.0.15",
+    "@push.rocks/smartrequest": "^2.0.18",
-    "@pushrocks/smartshell": "^3.0.3",
+    "@push.rocks/smartshell": "^3.0.3",
-    "@pushrocks/smartsocket": "^2.0.19",
+    "@push.rocks/smartsocket": "^2.0.22",
-    "@pushrocks/smartssh": "^2.0.0",
+    "@push.rocks/smartssh": "^2.0.1",
-    "@pushrocks/smartstring": "^4.0.7",
+    "@push.rocks/smartstring": "^4.0.8",
-    "@servezone/interfaces": "^1.0.3",
+    "@serve.zone/interfaces": "^1.0.3",
     "@tsclass/tsclass": "^4.0.42",
     "@types/through2": "^2.0.38",
     "through2": "^4.0.2"
@@ -73,5 +73,22 @@
   ],
   "browserslist": [
     "last 1 chrome versions"
+  ],
+  "keywords": [
+    "Node.js",
+    "Docker",
+    "GitLab CI",
+    "GitHub CI",
+    "Gitea CI",
+    "CI/CD",
+    "automation",
+    "npm",
+    "TypeScript",
+    "cloud",
+    "SSH",
+    "registry",
+    "container management",
+    "continuous integration",
+    "continuous deployment"
   ]
 }

readme.hints.md

@@ -0,0 +1,2 @@
+- focus on cli usage in CI environments.
+- show Gitlab CI, GitHub CI and Gitea CI examples.

readme.md

@@ -1,110 +1,494 @@
-# @shipzone/npmci
+# @ship.zone/npmci
-node and docker in gitlab ci on steroids
+A tool to enhance Node.js and Docker workflows within GitLab CI, providing various CI/CD utilities.
 
-## Availabililty and Links
+## Install
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@shipzone/npmci)
-* [gitlab.com (source)](https://gitlab.com/shipzone/npmci)
-* [github.com (source mirror)](https://github.com/shipzone/npmci)
-* [docs (typedoc)](https://shipzone.gitlab.io/npmci/)
 
-## Status for master
+To install `@ship.zone/npmci`, you can use npm or yarn:
 
-Status Category | Status Badge
+```sh
--- | --
+# Using npm
-GitLab Pipelines | [![pipeline status](https://gitlab.com/shipzone/npmci/badges/master/pipeline.svg)](https://lossless.cloud)
+npm install @ship.zone/npmci
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/shipzone/npmci/badges/master/coverage.svg)](https://lossless.cloud)
+
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@shipzone/npmci)](https://lossless.cloud)
+# Using yarn
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/shipzone/npmci)](https://lossless.cloud)
+yarn add @ship.zone/npmci
-TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+```
-node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@shipzone/npmci)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@shipzone/npmci)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@shipzone/npmci)](https://lossless.cloud)
 
 ## Usage
 
-Use TypeScript for best in class instellisense.
+`npmci` is designed to streamline CI/CD processes, particularly in Docker and Node.js environments. The following sections illustrate its usage in various scenarios, from handling Node versions to building Docker images and more.
 
-npmci is designed to work in docker CI environments. The following docker images come with npmci presinstalled:
+### 1. Integration with GitLab CI, GitHub CI, and Gitea CI
 
-Docker Hub:
+#### GitLab CI
 
-- [hosttoday/ht-docker-node:npmci](https://hub.docker.com/r/hosttoday/ht-docker-node/)  
+An example of integrating `npmci` into a GitLab CI configuration could look like this:
-  has LTS node version and npmci preinstalled.
-- [hosttoday/ht-docker-dbase](https://hub.docker.com/r/hosttoday/ht-docker-dbase/)  
-  based on docker:git, can be used to build docker images in conjunction with docker:dind
 
-npmci can be called from commandline and handle a lot of tasks durug ci:
+```yaml
+image: hosttoday/ht-docker-node:npmci
 
-```shell
+stages:
-# Handle node versions
+  - prepare
-npmci node install stable # will install latest stable node version and update PATH for node and npm
+  - build
-npmci node install lts # will install latest LTS node version and update PATH for node and npm versions
+  - test
-npmci node install legacy # will install latest legacy node version and update PATH for node and npm
+  - deploy
-npmci node install x.x.x #  will install any specific node version.
 
-# Handle npm and yarn tasks
+default:
-npmcu npm login # logs in npm using the auth key provided at env var "NPMCI_TOKEN_NPM"
+  before_script:
-npmci npm install  # installs dependencies using npm or yarn dependending on availablity
+    - npmci node install stable
-npmci npm test # tests the package
+    - npmci npm install
-npmci npm publish # builds a package and publishes it
 
-# handle docker tasks
+prepare:
-npmci docker prepare
+  stage: prepare
-## npmci test docker will look at all Dockerfiles and look for according tags on GitLab container registry
+  script:
+    - npmci prepare npm
+    - npmci prepare docker
 
+build:
+  stage: build
+  script:
+    - npmci docker build
 
-# prepare tools
+test:
-npmci prepare npm # will look for $NPMCI_TOKEN_NPM env var and create .npmrc, so npm is authenticated
+  stage: test
-npmci prepare docker # will look for $NPMCI_LOGIN_DOCKER in form username|password and authenticate docker
+  script:
-npmci prepare docker-gitlab # will authenticate docker for gitlab container registry
+    - npmci npm test
 
-# build containers
+deploy:
-npmci docker build # will build containers
+  stage: deploy
-## all Dockerfiles named Dockerfile* are picked up.
+  script:
-## specify tags like this Dockerfile_[tag]
+    - npmci publish npm
-## uploads all built images as [username]/[reponame]:[tag]_test to GitLab
+    - npmci docker push
-## then test in next step with "npmci test docker"
 
-# publish npm module
+  environment:
-npmci publish npm # will look vor $NPMCI_TOKEN_NPM env var and push any module in cwd to npm
+    name: production
-npmci publish docker
+    url: http://example.com
-
-# trigger webhooks
-npmci trigger # will look for NPMCI_TRIGGER_1 to NPMCI_TRIGGER_100 in form domain|id|token|ref|name
 ```
 
-## Configuration
+#### GitHub Actions
 
-npmci supports the use of npmextra.
+Similarly, you can set up `npmci` in GitHub Actions:
 
-To configure npmci create a `npmextra.json` file at the root of your project
+```yaml
+name: CI Pipeline
 
-```json
+on:
-{
+  push:
-  "npmci": {
+    branches:
-    "globalNpmTools": ["npm-check-updates", "protractor", "npmts", "gitzone"]
+      - main
-  }
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - run: npm install -g @ship.zone/npmci
+      - run: npmci node install stable
+      - run: npmci npm install
+
+  build:
+    runs-on: ubuntu-latest
+    needs: prepare
+    steps:
+      - run: npmci docker build
+
+  test:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - run: npmci npm test
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - run: npmci publish npm
+      - run: npmci docker push
+```
+
+#### Gitea CI
+
+Lastly, for Gitea CI:
+
+```yaml
+image: hosttoday/ht-docker-node:npmci
+
+pipelines:
+  default:
+    - step:
+        name: Prepare
+        image: hosttoday/ht-docker-node:npmci
+        commands:
+          - npmci node install stable
+          - npmci npm install
+          - npmci prepare npm
+          - npmci prepare docker
+
+    - step:
+        name: Build
+        image: hosttoday/ht-docker-node:npmci
+        commands:
+          - npmci docker build
+
+    - step:
+        name: Test
+        image: hosttoday/ht-docker-node:npmci
+        commands:
+          - npmci npm test
+
+    - step:
+        name: Deploy
+        image: hosttoday/ht-docker-node:npmci
+        commands:
+          - npmci publish npm
+          - npmci docker push
+```
+
+### 2. Handle Node Versions
+
+One of the core features of `npmci` is managing Node versions in your CI environment. You can specify which version of Node to install:
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+
+async function manageNodeVersions() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+
+  await npmciInstance.nodejsManager.handleCli({
+    _: ['node', 'install', 'stable'] // Installs the latest stable version
+  });
+
+  await npmciInstance.nodejsManager.handleCli({
+    _: ['node', 'install', 'lts'] // Installs the Long-Term Support (LTS) version
+  });
+
+  await npmciInstance.nodejsManager.handleCli({
+    _: ['node', 'install', 'legacy'] // Installs a legacy version
+  });
+
+  await npmciInstance.nodejsManager.handleCli({
+    _: ['node', 'install', '14.17.0'] // Install a specific version of Node
+  });
 }
+
+manageNodeVersions().then(() => console.log('Node versions managed successfully.'));
 ```
 
-**Available options**
+### 3. Handling npm and Yarn Tasks
 
-| setting        | example                       | description                                                                                       |
+`npmci` provides numerous utilities to streamline npm and yarn workflow tasks within a CI/CD pipeline.
-| -------------- | ----------------------------- | ------------------------------------------------------------------------------------------------- |
-| globalNpmTools | "globalNpmTools": ["gitbook"] | Will look for the specified package names locally and (if not yet present) install them from npm. |
 
-For further information read the linked docs at the top of this README.
+```typescript
+import { Npmci } from '@ship.zone/npmci';
 
-Use TypeScript for best in class instellisense.
+async function manageNpmTasks() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
 
-## Contribution
+  await npmciInstance.npmManager.handleCli({ _: ['npm', 'install'] }); // Installs dependencies
+  await npmciInstance.npmManager.handleCli({ _: ['npm', 'test'] }); // Runs tests
+  await npmciInstance.npmManager.handleCli({ _: ['npm', 'publish'] }); // Publishes the package
+}
 
-We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+manageNpmTasks().then(() => console.log('Npm tasks handled successfully.'));
+```
 
-For further information read the linked docs at the top of this readme.
+### 4. Docker Task Handling
 
-## Legal
+`npmci` simplifies Docker operations, particularly in building, testing, and publishing Docker images.
-> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+**Prepare Docker Environment:**
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+
+async function prepareDocker() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+
+  await npmciInstance.dockerManager.handleCli({ _: ['docker', 'prepare'] }); // Prepares Docker environment
+}
+
+prepareDocker().then(() => console.log('Docker environment prepared successfully.'));
+```
+
+**Building Docker Images:**
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+
+async function buildDockerImages() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+
+  await npmciInstance.dockerManager.handleCli({ _: ['docker', 'build'] }); // Builds Docker images
+}
+
+buildDockerImages().then(() => console.log('Docker images built successfully.'));
+```
+
+**Testing Docker Images:**
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+
+async function testDockerImages() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+
+  await npmciInstance.dockerManager.handleCli({ _: ['docker', 'test'] }); // Tests Docker images
+}
+
+testDockerImages().then(() => console.log('Docker images tested successfully.'));
+```
+
+**Publishing Docker Images:**
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+
+async function pushDockerImages() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+
+  await npmciInstance.dockerManager.handleCli({ _: ['docker', 'push'] }); // Pushes Docker images to registry
+}
+
+pushDockerImages().then(() => console.log('Docker images pushed successfully.'));
+```
+
+### 5. Managing Docker Registries
+
+`npmci` can handle multiple Docker registries and allows for easy integration within your CI pipeline.
+
+**Logging in to Docker Registries:**
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+
+async function loginToDockerRegistries() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+
+  await npmciInstance.dockerManager.handleCli({ _: ['docker', 'login'] }); // Logs into all configured Docker registries
+}
+
+loginToDockerRegistries().then(() => console.log('Logged into Docker registries.'));
+```
+
+**Pulling Docker Images:**
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+
+async function pullDockerImages() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+
+  await npmciInstance.dockerManager.handleCli({ _: ['docker', 'pull', 'registry.gitlab.com/mygroup/myrepo'] }); // Pulls Docker images from a registry
+}
+
+pullDockerImages().then(() => console.log('Docker images pulled successfully.'));
+```
+
+### 6. SSH Key Management
+
+`npmci` also simplifies the management of SSH keys, which is crucial for accessing private repositories and servers.
+
+**Preparing SSH Keys:**
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+
+async function prepareSshKeys() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+
+  await npmciInstance.sshManager.handleCli({ _: ['ssh', 'prepare'] }); // Prepares SSH keys from environment variables
+}
+
+prepareSshKeys().then(() => console.log('SSH keys prepared successfully.'));
+```
+
+### 7. Cloudron Integration
+
+For users deploying applications on Cloudron, `npmci` provides a set of utilities for automating Cloudron tasks.
+
+**Deploying to Cloudron:**
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+
+async function deployToCloudron() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+
+  await npmciInstance.cloudronManager.handleCli({
+    _: ['cloudron', 'deploy']
+  }); // Deploys application to Cloudron platform
+}
+
+deployToCloudron().then(() => console.log('Deployment to Cloudron completed.'));
+```
+
+**Preparing Cloudron Manifest:**
+Before deployment, replace version placeholders in the Cloudron Manifest:
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+import * as fs from 'fs';
+import * as path from 'path';
+
+async function prepareCloudronManifest(version: string) {
+  const manifestPath = path.join(process.cwd(), "CloudronManifest.json");
+  let manifestFile = fs.readFileSync(manifestPath, { encoding: 'utf-8' });
+  manifestFile = manifestFile.replace(/##version##/g, version);
+  fs.writeFileSync(manifestPath, manifestFile);
+  console.log('CloudronManifest prepared');
+}
+
+async function deployWithPreparedManifest() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+  
+  await prepareCloudronManifest('1.0.0');
+  await npmciInstance.cloudronManager.handleCli({
+    _: ['cloudron', 'deploy']
+  }); // Deploys application to Cloudron platform
+}
+
+deployWithPreparedManifest().then(() => console.log('Deployment to Cloudron with manifest preparation completed.'));
+```
+
+### 8. Webhook Triggers
+
+`npmci` supports webhook triggers, allowing you to trigger builds and other activities based on various conditions.
+
+**Triggering Webhooks:**
+
+```typescript
+import { Npmci } from '@ship.zone/npmci';
+
+async function triggerWebhooks() {
+  const npmciInstance = new Npmci();
+  await npmciInstance.start();
+
+  await npmciInstance.triggerManager.handleCli({
+    _: ['trigger']
+  }); // Triggers webhooks based on environment variables
+}
+
+triggerWebhooks().then(() => console.log('Webhooks triggered successfully.'));
+```
+
+### 9. Using the bash Helper
+
+`npmci` includes a bash helper for executing commands within a bash shell, useful for various custom tasks.
+
+**Using bash to Execute Commands:**
+
+```typescript
+import { bash } from '@ship.zone/npmci';
+
+async function runCustomBashCommand(command: string) {
+  const output = await bash(command);
+  console.log('Command output:', output);
+}
+
+runCustomBashCommand('echo Hello World').then(() => console.log('Custom command executed successfully.'));
+```
+
+### Full Features and Use Cases
+
+Below is a comprehensive set of features and use cases supported by `npmci`. This section ensures you can take full advantage of the library's capabilities in multiple scenarios.
+
+### Comprehensive Docker Workflow
+
+**Step-by-step Docker Image Handling:**
+
+1. **Detect and Build All Dockerfiles:**
+
+   ```typescript
+   import { Npmci } from '@ship.zone/npmci';
+
+   async function detectAndBuildDockerfiles() {
+     const npmciInstance = new Npmci();
+     await npmciInstance.start();
+     const dockerfiles = await npmciInstance.dockerManager.getDockerfiles();
+     console.log('Dockerfiles detected:', dockerfiles.map(d => d.filePath));
+     
+     await npmciInstance.dockerManager.handleCli({ _: ['docker', 'build'] });
+     console.log('Dockerfiles built successfully.');
+   }
+
+   detectAndBuildDockerfiles().then(() => console.log('Docker detection and build process completed.'));
+   ```
+
+2. **Test All Dockerfiles:**
+
+   ```typescript
+   import { Npmci } from '@ship.zone/npmci';
+
+   async function testAllDockerfiles() {
+     const npmciInstance = new Npmci();
+     await npmciInstance.start();
+     await npmciInstance.dockerManager.handleCli({ _: ['docker', 'test'] });
+     console.log('Dockerfiles tested successfully.');
+   }
+
+   testAllDockerfiles().then(() => console.log('Docker testing process completed.'));
+   ```
+
+3. **Push Dockerfiles to a Registry:**
+
+   ```typescript
+   import { Npmci } from '@ship.zone/npmci';
+
+   async function pushDockerfilesToRegistry() {
+     const npmciInstance = new Npmci();
+     await npmciInstance.start();
+     
+     await npmciInstance.dockerManager.handleCli({ _: ['docker', 'push'] });
+     console.log('Dockerfiles pushed to registry successfully.');
+   }
+
+   pushDockerfilesToRegistry().then(() => console.log('Docker push process completed.'));
+   ```
+
+**Dockerfile Class Example:**
+
+Here's a snippet showcasing how the `Dockerfile` class can be used to handle Dockerfile-specific operations:
+
+```typescript
+import { Dockerfile } from '@ship.zone/npmci';
+
+async function handleDockerfileOperations() {
+  // Initialize Dockerfile instances
+  const dockerfile1 = new Dockerfile(/* required parameters */);
+  const dockerfile2 = new Dockerfile(/* required parameters */);
+
+  // Read and sort Dockerfiles
+  const dockerfiles = await Dockerfile.readDockerfiles(/* required parameters */);
+  const sortedDockerfiles = await Dockerfile.sortDockerfiles(dockerfiles);
+
+  // Build and Test Dockerfiles
+  await Dockerfile.buildDockerfiles(sortedDockerfiles);
+  await Dockerfile.testDockerfiles(sortedDockerfiles);
+
+  // Push Dockerfile images to a registry
+  for (const dockerfile of sortedDockerfiles) {
+    await dockerfile.push(/* registry and tag parameters */);
+  }
+
+  console.log('Dockerfile operations completed successfully.');
+}
+
+handleDockerfileOperations().then(() => console.log('Dockerfile processing flow completed.'));
+```
+
+This completes the comprehensive guide to `@ship.zone/npmci`. With the examples and explanations provided, you should be able to harness the full power and flexibility of the library to streamline your CI/CD processes effectively.
+undefined

test/assets/Dockerfile_hello_##version##

@@ -0,0 +1,2 @@
+FROM mygroup/myrepo:sometag2
+RUN apt-get update

test/test.cloudly.ts

@@ -1,5 +1,5 @@
 process.env['NODE_TLS_REJECT_UNAUTHORIZED'] = '0';
-import { tap, expect } from '@pushrocks/tapbundle';
+import { tap, expect } from '@push.rocks/tapbundle';
 
 import * as cloudlyConnectorMod from '../ts/connector.cloudly/cloudlyconnector.js';
 

test/test.ts

@@ -1,6 +1,6 @@
-import { tap, expect } from '@pushrocks/tapbundle';
+import { tap, expect } from '@push.rocks/tapbundle';
 import * as path from 'path';
-import * as smartpath from '@pushrocks/smartpath';
+import * as smartpath from '@push.rocks/smartpath';
 
 process.env.NPMTS_TEST = 'true';
 process.env.NPMCI_URL_CLOUDLY = 'localhost';
@@ -19,24 +19,20 @@ process.cwd = () => {
   return path.join(smartpath.get.dirnameFromImportMetaUrl(import.meta.url), 'assets/');
 };
 
-let npmci: typeof import('../ts/index.js');
+import type * as npmciTypes from '../ts/index.js';
-
+const npmci = await import('../ts/index.js');
-type TNpmciTypes = typeof import('../ts/index.js');
-
-tap.preTask('should import npmci', async () => {
-  npmci = await import('../ts/index.js');
-});
 
 // ======
 // Docker
 // ======
 
-let dockerfile1: npmci.Dockerfile;
+let dockerfile1: npmciTypes.Dockerfile;
-let dockerfile2: npmci.Dockerfile;
+let dockerfile2: npmciTypes.Dockerfile;
-let sortableArray: npmci.Dockerfile[];
+let sortableArray: npmciTypes.Dockerfile[];
 
 tap.test('should return valid Dockerfiles', async () => {
   const npmciInstance = new npmci.Npmci();
+  await npmciInstance.start();
   dockerfile1 = new npmci.Dockerfile(npmciInstance.dockerManager, {
     filePath: './Dockerfile',
     read: true,
@@ -51,8 +47,9 @@ tap.test('should return valid Dockerfiles', async () => {
 
 tap.test('should read a directory of Dockerfiles', async () => {
   const npmciInstance = new npmci.Npmci();
+  await npmciInstance.start();
   return npmci.Dockerfile.readDockerfiles(npmciInstance.dockerManager).then(
-    async (readDockerfilesArrayArg: npmci.Dockerfile[]) => {
+    async (readDockerfilesArrayArg: npmciTypes.Dockerfile[]) => {
       sortableArray = readDockerfilesArrayArg;
       return expect(readDockerfilesArrayArg[1].version).toEqual('sometag1');
     }
@@ -61,7 +58,7 @@ tap.test('should read a directory of Dockerfiles', async () => {
 
 tap.test('should sort an array of Dockerfiles', async () => {
   return npmci.Dockerfile.sortDockerfiles(sortableArray).then(
-    async (sortedArrayArg: npmci.Dockerfile[]) => {
+    async (sortedArrayArg: npmciTypes.Dockerfile[]) => {
       console.log(sortedArrayArg);
     }
   );
@@ -69,6 +66,7 @@ tap.test('should sort an array of Dockerfiles', async () => {
 
 tap.test('should build all Dockerfiles', async () => {
   const npmciInstance = new npmci.Npmci();
+  await npmciInstance.start();
   return npmciInstance.dockerManager.handleCli({
     _: ['docker', 'build'],
   });
@@ -76,6 +74,7 @@ tap.test('should build all Dockerfiles', async () => {
 
 tap.test('should test all Dockerfiles', async () => {
   const npmciInstance = new npmci.Npmci();
+  await npmciInstance.start();
   return npmciInstance.dockerManager.handleCli({
     _: ['docker', 'test'],
   });
@@ -83,6 +82,7 @@ tap.test('should test all Dockerfiles', async () => {
 
 tap.test('should test dockerfiles', async () => {
   const npmciInstance = new npmci.Npmci();
+  await npmciInstance.start();
   return npmciInstance.dockerManager.handleCli({
     _: ['docker', 'test'],
   });
@@ -90,6 +90,7 @@ tap.test('should test dockerfiles', async () => {
 
 tap.test('should login docker daemon', async () => {
   const npmciInstance = new npmci.Npmci();
+  await npmciInstance.start();
   return npmciInstance.dockerManager.handleCli({
     _: ['docker', 'login'],
   });
@@ -110,6 +111,7 @@ tap.test('should prepare SSH keys', async () => {
 // ====
 tap.test('should install a certain version of node', async () => {
   const npmciInstance = new npmci.Npmci();
+  await npmciInstance.start();
   await npmciInstance.nodejsManager.handleCli({
     _: ['node', 'install', 'stable'],
   });

ts/00_commitinfo_data.ts

@@ -2,7 +2,7 @@
  * autocreated commitinfo by @pushrocks/commitinfo
  */
 export const commitinfo = {
-  name: '@shipzone/npmci',
+  name: '@ship.zone/npmci',
-  version: '4.1.15',
+  version: '4.1.31',
-  description: 'node and docker in gitlab ci on steroids'
+  description: 'A tool to streamline Node.js and Docker workflows within CI environments, particularly GitLab CI, providing various CI/CD utilities.'
 }

ts/index.ts

@@ -6,5 +6,5 @@ export const npmciInstance = new Npmci();
 export { Dockerfile, Npmci };
 
 export const runCli = async () => {
-  npmciInstance.start();
+  await npmciInstance.start();
 };

ts/manager.cloudron/index.ts

@@ -0,0 +1,67 @@
+import { logger } from '../npmci.logging.js';
+import * as plugins from './mod.plugins.js';
+import * as paths from '../npmci.paths.js';
+import { bash } from '../npmci.bash.js';
+import { Npmci } from '../npmci.classes.npmci.js';
+
+export class NpmciCloudronManager {
+  public npmciRef: Npmci;
+
+  constructor(npmciArg: Npmci) {
+    this.npmciRef = npmciArg;
+  }
+
+  /**
+   * handle cli input
+   * @param argvArg
+   */
+  public handleCli = async (argvArg: any) => {
+    if (argvArg._.length >= 2) {
+      const action: string = argvArg._[1];
+      switch (action) {
+        case 'deploy':
+          await this.deploy();
+          break;
+        default:
+          logger.log('error', `>>npmci cloudron ...<< action >>${action}<< not supported`);
+      }
+    } else {
+      logger.log(
+        'info',
+        `>>npmci cloudron ...<< cli arguments invalid... Please read the documentation.`
+      );
+    }
+  };
+
+  /**
+   * Replaces the version string in CloudronManifest file
+   * @param versionArg
+   */
+  public deploy = async () => {
+    logger.log('info', 'now deploying to cloudron...');
+    logger.log('info', 'installing cloudron cli...');
+    await bash(`pnpm install -g cloudron`);
+    logger.log('ok', 'cloudron cli installed');
+
+    // lets set the version in the CloudronManifest file
+    await this.prepareCloudronManifest(this.npmciRef.npmciConfig.getConfig().projectInfo.npm.version);
+    logger.log('ok', 'CloudronManifest prepared');
+
+    // lets figure out the docker image tag
+    const dockerImageTag = await this.npmciRef.npmciConfig.kvStorage.readKey('latestPushedDockerTag');
+    const appName = this.npmciRef.npmciConfig.getConfig().cloudronAppName;
+    
+    const cloudronEnvVar = process.env.NPMCI_LOGIN_CLOUDRON;
+    const cloudronServer = cloudronEnvVar.split('|')[0];
+    const cloudronToken = cloudronEnvVar.split('|')[1];
+    await bash(`cloudron update --server ${cloudronServer} --token ${cloudronToken} --image ${dockerImageTag} --app ${appName}`);
+  };
+
+  private prepareCloudronManifest = async (versionArg: string) => {
+    const manifestPath = plugins.path.join(paths.cwd, 'CloudronManifest.json');
+    let manifestFile = plugins.smartfile.fs.toStringSync(manifestPath);
+    manifestFile = manifestFile.replace(/##version##/g, versionArg);
+    plugins.smartfile.memory.toFsSync(manifestFile, manifestPath);
+    logger.log('info', 'Version replaced in CloudronManifest file');
+  }
+}

ts/manager.cloudron/mod.plugins.ts

@@ -0,0 +1 @@
+export * from '../npmci.plugins.js';

ts/manager.docker/index.ts

@@ -93,7 +93,7 @@ export class NpmciDockerManager {
     }
 
     // handle registries
-    await plugins.smartparam.forEachMinimatch(
+    await plugins.smartobject.forEachMinimatch(
       process.env,
       'NPMCI_LOGIN_DOCKER*',
       async (envString: string) => {
@@ -179,4 +179,12 @@ export class NpmciDockerManager {
     await this.prepare();
     return await Dockerfile.readDockerfiles(this).then(Dockerfile.testDockerfiles);
   };
+
+  /**
+   * can be used to get the Dockerfiles in the directory
+   */
+  getDockerfiles = async () => {
+    const dockerfiles = await Dockerfile.readDockerfiles(this);
+    return dockerfiles;
+  }
 }

ts/manager.docker/mod.classes.dockerfile.ts

@@ -117,20 +117,24 @@ export class Dockerfile {
   }
 
   /**
-   * returns a version for a docker file
+ * returns a version for a docker file
-   * @execution SYNC
+ * @execution SYNC
-   */
+ */
-  public static dockerFileVersion(dockerfileNameArg: string): string {
+public static dockerFileVersion(dockerfileInstanceArg: Dockerfile, dockerfileNameArg: string): string {
-    let versionString: string;
+  let versionString: string;
-    const versionRegex = /Dockerfile_([a-zA-Z0-9\.]*)$/;
+  const versionRegex = /Dockerfile_(.+)$/;
-    const regexResultArray = versionRegex.exec(dockerfileNameArg);
+  const regexResultArray = versionRegex.exec(dockerfileNameArg);
-    if (regexResultArray && regexResultArray.length === 2) {
+  if (regexResultArray && regexResultArray.length === 2) {
-      versionString = regexResultArray[1];
+    versionString = regexResultArray[1];
-    } else {
+  } else {
-      versionString = 'latest';
+    versionString = 'latest';
-    }
-    return versionString;
   }
+  versionString = versionString.replace(
+    '##version##',
+    dockerfileInstanceArg.npmciDockerManagerRef.npmciRef.npmciConfig.getConfig().projectInfo.npm.version
+  );
+  return versionString;
+}
 
   /**
    * returns the docker base image for a Dockerfile
@@ -233,7 +237,7 @@ export class Dockerfile {
       this.npmciDockerManagerRef.npmciRef.npmciEnv.repo.user +
       '/' +
       this.npmciDockerManagerRef.npmciRef.npmciEnv.repo.repo;
-    this.version = Dockerfile.dockerFileVersion(plugins.path.parse(options.filePath).base);
+    this.version = Dockerfile.dockerFileVersion(this, plugins.path.parse(options.filePath).base);
     this.cleanTag = this.repo + ':' + this.version;
     this.buildTag = this.cleanTag;
 
@@ -281,6 +285,7 @@ export class Dockerfile {
       labels: [],
       version: this.npmciDockerManagerRef.npmciRef.npmciConfig.getConfig().projectInfo.npm.version,
     });
+    await this.npmciDockerManagerRef.npmciRef.npmciConfig.kvStorage.writeKey('latestPushedDockerTag', this.pushTag)
   }
 
   /**

ts/manager.docker/mod.classes.registrystorage.ts

@@ -1,11 +1,10 @@
 import { logger } from '../npmci.logging.js';
 import * as plugins from './mod.plugins.js';
-import { ObjectMap } from '@pushrocks/lik';
 
 import { DockerRegistry } from './mod.classes.dockerregistry.js';
 
 export class RegistryStorage {
-  objectMap = new ObjectMap<DockerRegistry>();
+  objectMap = new plugins.lik.ObjectMap<DockerRegistry>();
   constructor() {
     // Nothing here
   }

ts/manager.npm/index.ts

@@ -54,7 +54,7 @@ export class NpmciNpmManager {
   public async prepare() {
     const config = this.npmciRef.npmciConfig.getConfig();
     let npmrcFileString: string = '';
-    await plugins.smartparam.forEachMinimatch(
+    await plugins.smartobject.forEachMinimatch(
       process.env,
       'NPMCI_TOKEN_NPM*',
       (npmEnvArg: string) => {
@@ -100,7 +100,7 @@ export class NpmciNpmManager {
       let publishVerdaccioAsWell = false;
       const config = this.npmciRef.npmciConfig.getConfig();
       const availableRegistries: string[] = [];
-      await plugins.smartparam.forEachMinimatch(
+      await plugins.smartobject.forEachMinimatch(
         process.env,
         'NPMCI_TOKEN_NPM*',
         (npmEnvArg: string) => {

ts/mod_ssh/index.ts

@@ -31,7 +31,7 @@ const notUndefined = (stringArg: string) => {
  */
 export let prepare = async () => {
   sshInstance = new plugins.smartssh.SshInstance(); // init ssh instance
-  plugins.smartparam.forEachMinimatch(process.env, 'NPMCI_SSHKEY_*', evaluateSshEnv);
+  plugins.smartobject.forEachMinimatch(process.env, 'NPMCI_SSHKEY_*', evaluateSshEnv);
   if (!process.env.NPMTS_TEST) {
     sshInstance.writeToDisk();
   } else {

ts/mod_trigger/index.ts

@@ -7,7 +7,7 @@ const triggerValueRegex =
 
 export let trigger = async () => {
   logger.log('info', 'now running triggers');
-  await plugins.smartparam.forEachMinimatch(process.env, 'NPMCI_TRIGGER_*', evaluateTrigger);
+  await plugins.smartobject.forEachMinimatch(process.env, 'NPMCI_TRIGGER_*', evaluateTrigger);
 };
 
 const evaluateTrigger = async (triggerEnvVarArg) => {

ts/npmci.bash.ts

@@ -2,12 +2,10 @@ import { logger } from './npmci.logging.js';
 import * as plugins from './npmci.plugins.js';
 import * as paths from './npmci.paths.js';
 
-import * as smartpromise from '@pushrocks/smartpromise';
-
 /**
  * wether nvm is available or not
  */
-export let nvmAvailable = smartpromise.defer<boolean>();
+export let nvmAvailable = plugins.smartpromise.defer<boolean>();
 /**
  * the smartshell instance for npmci
  */

ts/npmci.classes.npmci.ts

@@ -1,17 +1,21 @@
 import * as plugins from './npmci.plugins.js';
 
-import { CloudlyConnector } from './connector.cloudly/cloudlyconnector.js';
 
+// env
+import { NpmciEnv } from './npmci.classes.npmcienv.js';
 import { NpmciInfo } from './npmci.classes.npmciinfo.js';
 import { NpmciCli } from './npmci.classes.npmcicli.js';
 import { NpmciConfig } from './npmci.classes.npmciconfig.js';
 
-// mods
+// connectors
+import { CloudlyConnector } from './connector.cloudly/cloudlyconnector.js';
+
+// managers
+import { NpmciCloudronManager } from './manager.cloudron/index.js';
 import { NpmciDockerManager } from './manager.docker/index.js';
 import { NpmciGitManager } from './manager.git/index.js';
 import { NpmciNodeJsManager } from './manager.nodejs/index.js';
 import { NpmciNpmManager } from './manager.npm/index.js';
-import { NpmciEnv } from './npmci.classes.npmcienv.js';
 
 export class Npmci {
   public analytics: plugins.smartanalytics.Analytics;
@@ -23,6 +27,7 @@ export class Npmci {
   public npmciCli: NpmciCli;
 
   // managers
+  public cloudronManager: NpmciCloudronManager;
   public dockerManager: NpmciDockerManager;
   public gitManager: NpmciGitManager;
   public nodejsManager: NpmciNodeJsManager;
@@ -34,22 +39,23 @@ export class Npmci {
       projectId: 'gitzone',
       appName: 'npmci',
     });
+  }
+
+  public async start() {
     this.cloudlyConnector = new CloudlyConnector(this);
     this.npmciEnv = new NpmciEnv(this);
     this.npmciInfo = new NpmciInfo(this);
+    await this.npmciInfo.printToConsole();
     this.npmciCli = new NpmciCli(this);
     this.npmciConfig = new NpmciConfig(this);
+    await this.npmciConfig.init();
 
     // managers
+    this.cloudronManager = new NpmciCloudronManager(this);
     this.dockerManager = new NpmciDockerManager(this);
     this.gitManager = new NpmciGitManager(this);
     this.nodejsManager = new NpmciNodeJsManager(this);
     this.npmManager = new NpmciNpmManager(this);
-  }
-
-  public async start() {
-    await this.npmciInfo.printToConsole();
-    await this.npmciConfig.init();
     this.npmciCli.startParse();
   }
 }

ts/npmci.classes.npmcicli.ts

@@ -24,6 +24,17 @@ export class NpmciCli {
       }
     );
 
+    // cloudron
+    this.smartcli.addCommand('cloudron').subscribe(
+      async (argv) => {
+        await this.npmciRef.cloudronManager.handleCli(argv);
+      },
+      (err) => {
+        console.log(err);
+        process.exit(1);
+      }
+    );
+
     // command
     this.smartcli.addCommand('command').subscribe(
       async (argv) => {
@@ -36,7 +47,7 @@ export class NpmciCli {
       }
     );
 
-    // command
+    // git
     this.smartcli.addCommand('git').subscribe(
       async (argvArg) => {
         await this.npmciRef.gitManager.handleCli(argvArg);

ts/npmci.classes.npmciconfig.ts

@@ -25,6 +25,9 @@ export interface INpmciOptions {
 
   // urls
   urlCloudly: string;
+
+  // cloudron
+  cloudronAppName?: string;
 }
 
 /**
@@ -41,10 +44,12 @@ export class NpmciConfig {
 
   constructor(npmciRefArg: Npmci) {
     this.npmciRef = npmciRefArg;
+  }
 
+  public async init() {
     this.npmciNpmextra = new plugins.npmextra.Npmextra(paths.cwd);
     this.kvStorage = new plugins.npmextra.KeyValueStore(
-      'custom',
+      'userHomeDir',
       `${this.npmciRef.npmciEnv.repo.user}_${this.npmciRef.npmciEnv.repo.repo}`
     );
     this.npmciQenv = new plugins.qenv.Qenv(
@@ -62,11 +67,8 @@ export class NpmciConfig {
       npmRegistryUrl: 'registry.npmjs.org',
       gitlabRunnerTags: [],
       dockerBuildargEnvMap: {},
-      urlCloudly: this.npmciQenv.getEnvVarOnDemand('NPMCI_URL_CLOUDLY'),
+      urlCloudly: await this.npmciQenv.getEnvVarOnDemand('NPMCI_URL_CLOUDLY'),
     };
-  }
-
-  public async init() {
     this.configObject = this.npmciNpmextra.dataFor<INpmciOptions>('npmci', this.configObject);
   }
 

ts/npmci.classes.npmciinfo.ts

@@ -11,7 +11,7 @@ export class NpmciInfo {
     this.npmciRef = npmciArg;
   }
 
-  public printToConsole() {
+  public async printToConsole() {
-    logger.log('info', `npmci version: ${this.projectInfo.version}`);
+    await logger.log('info', `npmci version: ${this.projectInfo.version}`);
   }
 }

ts/npmci.plugins.ts

@@ -4,7 +4,7 @@ import * as path from 'path';
 export { path };
 
 // @apiglobal
-import * as typedrequest from '@apiglobal/typedrequest';
+import * as typedrequest from '@api.global/typedrequest';
 
 export { typedrequest };
 
@@ -13,27 +13,29 @@ import * as servezoneInterfaces from '@servezone/interfaces';
 
 export { servezoneInterfaces };
 
-// @pushrocks
+// @push.rocks
-import * as npmextra from '@pushrocks/npmextra';
+import * as lik from '@push.rocks/lik';
-import * as projectinfo from '@pushrocks/projectinfo';
+import * as npmextra from '@push.rocks/npmextra';
-import * as qenv from '@pushrocks/qenv';
+import * as projectinfo from '@push.rocks/projectinfo';
-import * as smartanalytics from '@pushrocks/smartanalytics';
+import * as qenv from '@push.rocks/qenv';
-import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartanalytics from '@push.rocks/smartanalytics';
-import * as smartfile from '@pushrocks/smartfile';
+import * as smartdelay from '@push.rocks/smartdelay';
-import * as smartcli from '@pushrocks/smartcli';
+import * as smartfile from '@push.rocks/smartfile';
-import * as smartgit from '@pushrocks/smartgit';
+import * as smartcli from '@push.rocks/smartcli';
-import * as smartlog from '@pushrocks/smartlog';
+import * as smartgit from '@push.rocks/smartgit';
-import * as smartlogDestinationLocal from '@pushrocks/smartlog-destination-local';
+import * as smartlog from '@push.rocks/smartlog';
-import * as smartparam from '@pushrocks/smartparam';
+import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
-import * as smartpath from '@pushrocks/smartpath';
+import * as smartobject from '@push.rocks/smartobject';
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartpath from '@push.rocks/smartpath';
-import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartpromise from '@push.rocks/smartpromise';
-import * as smartshell from '@pushrocks/smartshell';
+import * as smartrequest from '@push.rocks/smartrequest';
-import * as smartsocket from '@pushrocks/smartsocket';
+import * as smartshell from '@push.rocks/smartshell';
-import * as smartssh from '@pushrocks/smartssh';
+import * as smartsocket from '@push.rocks/smartsocket';
-import * as smartstring from '@pushrocks/smartstring';
+import * as smartssh from '@push.rocks/smartssh';
+import * as smartstring from '@push.rocks/smartstring';
 
 export {
+  lik,
   npmextra,
   projectinfo,
   qenv,
@@ -44,7 +46,7 @@ export {
   smartcli,
   smartlog,
   smartlogDestinationLocal,
-  smartparam,
+  smartobject,
   smartpath,
   smartpromise,
   smartrequest,

tsconfig.json

@@ -3,8 +3,12 @@
     "experimentalDecorators": true,
     "useDefineForClassFields": false,
     "target": "ES2022",
-    "module": "ES2022",
+    "module": "NodeNext",
-    "moduleResolution": "nodenext",
+    "moduleResolution": "NodeNext",
-    "esModuleInterop": true
+    "esModuleInterop": true,
-  }
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
 }