Compare commits

...

70 Commits

Author SHA1 Message Date
66d28e5081 4.1.32 2024-10-23 21:50:30 +02:00
9de77139ea fix(dependencies): Update project dependencies to latest versions 2024-10-23 21:50:30 +02:00
7b4bf10cc0 4.1.31 2024-05-24 15:54:33 +02:00
9eaa6347c1 fix(core): update 2024-05-24 15:54:32 +02:00
6e4c967917 4.1.30 2024-05-24 00:17:31 +02:00
52a8f42fc9 fix(core): update 2024-05-24 00:17:31 +02:00
8e9a61bbb2 4.1.29 2024-05-23 21:47:07 +02:00
dc809a6023 fix(core): update 2024-05-23 21:47:06 +02:00
7eeca992b0 4.1.28 2024-05-17 16:23:48 +02:00
d018102014 fix(core): update 2024-05-17 16:23:47 +02:00
838f2d6959 4.1.27 2023-08-24 17:25:56 +02:00
0d42e5f6eb fix(core): update 2023-08-24 17:25:55 +02:00
f96de8cdc3 4.1.26 2023-08-09 11:26:22 +02:00
965833916f fix(core): update 2023-08-09 11:26:22 +02:00
81ec1391e3 4.1.25 2023-08-09 11:23:57 +02:00
bbbca44640 fix(core): update 2023-08-09 11:23:56 +02:00
7ba7dc54a1 4.1.24 2023-08-08 23:32:08 +02:00
4f98eeec2a fix(core): update 2023-08-08 23:32:07 +02:00
419a6b9e5f 4.1.23 2023-07-13 16:00:47 +02:00
9c040c34f5 fix(core): update 2023-07-13 16:00:47 +02:00
50d3f2d795 4.1.22 2023-07-12 18:23:32 +02:00
305856b9e1 fix(core): update 2023-07-12 18:23:31 +02:00
3683743f3c 4.1.21 2023-07-12 15:35:39 +02:00
41237e0e5f fix(core): update 2023-07-12 15:35:38 +02:00
bce84a0e74 4.1.20 2023-07-02 00:10:28 +02:00
79bed919d8 fix(core): update 2023-07-02 00:10:27 +02:00
4b202ce00e 4.1.19 2023-07-01 22:09:54 +02:00
16ca787314 fix(core): update 2023-07-01 22:09:54 +02:00
3a9b6f658a 4.1.18 2023-07-01 22:05:44 +02:00
5c5dbf303f fix(core): update 2023-07-01 22:05:43 +02:00
4c07131e51 4.1.17 2023-07-01 19:23:17 +02:00
ba039469ff fix(core): update 2023-07-01 19:23:17 +02:00
49f2498ecd 4.1.16 2023-07-01 19:02:07 +02:00
1060060366 fix(core): update 2023-07-01 19:02:06 +02:00
0fa3a579f7 4.1.15 2023-06-26 10:09:25 +02:00
0e4556d59e fix(core): update 2023-06-26 10:09:24 +02:00
e2e7967fba 4.1.14 2023-06-26 09:28:19 +02:00
45b8d67abf fix(core): update 2023-06-26 09:28:19 +02:00
0a69aa5d62 4.1.13 2023-06-26 02:43:45 +02:00
dfbab1a1df fix(core): update 2023-06-26 02:43:45 +02:00
e58f009a24 4.1.12 2023-06-26 01:03:44 +02:00
2afd9cddc5 fix(core): update 2023-06-26 01:03:44 +02:00
d79c5366ef 4.1.11 2023-06-26 00:09:56 +02:00
8e4f7ad244 fix(core): update 2023-06-26 00:09:54 +02:00
39de3a1601 4.1.10 2023-06-25 23:59:26 +02:00
cb3d2964d1 fix(core): update 2023-06-25 23:59:25 +02:00
6b5390cef8 4.1.9 2023-06-25 23:26:25 +02:00
2736b85de3 fix(core): update 2023-06-25 23:26:25 +02:00
82d7778f59 4.1.8 2023-06-25 23:18:23 +02:00
8c99cc0491 fix(core): update 2023-06-25 23:18:23 +02:00
955e3d0dbe 4.1.7 2023-06-25 23:16:29 +02:00
702ae8bed8 fix(core): update 2023-06-25 23:16:29 +02:00
b6f0723b75 4.1.6 2023-06-25 22:23:31 +02:00
8a2fb30e59 fix(core): update 2023-06-25 22:23:30 +02:00
95b4030120 4.1.5 2023-06-25 21:15:51 +02:00
5c77cfbdc2 fix(core): update 2023-06-25 21:15:50 +02:00
5ea42320a9 4.1.4 2023-05-07 22:35:19 +02:00
d07ebfc9c6 fix(core): update 2023-05-07 22:35:18 +02:00
bbb5718184 4.1.3 2023-05-07 21:30:59 +02:00
0d8b54637c fix(core): update 2023-05-07 21:30:58 +02:00
e51b2e28b9 4.1.2 2022-11-02 18:57:47 +01:00
f767140cc8 fix(core): update 2022-11-02 18:57:47 +01:00
0d4d69f072 4.1.1 2022-11-02 16:43:54 +01:00
a3e628c43f fix(core): update 2022-11-02 16:43:54 +01:00
a58fa135c1 4.1.0 2022-10-24 21:23:14 +02:00
93c7af6c91 feat(precheck): now includes a precheck for more generic runner execution 2022-10-24 21:23:14 +02:00
ad0e12bf7b 4.0.11 2022-10-23 17:19:42 +02:00
498dd6eff6 fix(core): update 2022-10-23 17:19:41 +02:00
b3aa964739 4.0.10 2022-10-11 14:26:43 +02:00
03eb9d2657 fix(core): update 2022-10-11 14:26:42 +02:00
37 changed files with 4452 additions and 16197 deletions

View File

@@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@@ -0,0 +1,108 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_LOGIN_DOCKER_GITEA: ${{secrets.NPMCI_DOCKER_REGISTRYURL_DEFAULT}}|${{ gitea.repository_owner }}|${{ secrets.GITEA_TOKEN }}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm prepare
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

View File

@@ -1,141 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
before_script:
- pnpm install -g @shipzone/npmci pnpm
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
allow_failure: true
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

59
changelog.md Normal file
View File

@@ -0,0 +1,59 @@
# Changelog
## 2024-10-23 - 4.1.32 - fix(dependencies)
Update project dependencies to latest versions
- Updated development dependencies, including @git.zone/tsbuild and @git.zone/tsrun.
- Updated production dependencies such as @api.global/typedrequest and @push.rocks/smartfile.
## 2022-10-24 - 4.0.11 - prerelease
now includes a precheck for more generic runner execution
- Implemented a precheck feature for runners.
## 2022-10-09 to 2022-10-11 - 4.0.0 to 4.0.10 - migration
internal migrations and fixes
- Major switch to ESM style module: **BREAKING CHANGE**.
- Multiple fixes in core functionalities and module updates.
## 2019-11-26 - 3.1.73 - fixes
correctly setting npm cache and other updates
- Ensured correct npm cache setting during preparation.
- Various core updates.
## 2018-12-23 - 3.1.19 - privacy updates
enhanced mirroring controls for private code
- Now refusing to mirror private code.
## 2018-11-24 - 3.1.2 - ci improvement
removed unnecessary build dependency
- Removed npmts build dependency in CI pipeline.
## 2018-09-22 - 3.0.59 - enhancement
integrated smartlog for improved logging
- Logs now utilize smartlog for better management.
## 2017-09-08 - 3.0.14 - analytics
added analytics features
- Enabled analytics throughout the system.
## 2017-08-29 - 3.0.9 - docker enhancements
docker improvements and build args implementation
- Implemented working `dockerBuildArgEnvMap`.
## 2017-07-27 - 2.4.0 - stability improvements
various updates to stabilize the environment
- Fixed npmci versioning issues.
## 2016-11-25 - 2.3.24 - global tools
improved handling for global tool installations
- Improved install handling for needed global tools.

View File

@@ -1,5 +1,5 @@
#!/usr/bin/env node #!/usr/bin/env node
process.env.CLI_CALL = 'true'; 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); tsrun.runPath('./cli.child.js', import.meta.url);

View File

@@ -12,11 +12,28 @@
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "shipzone", "gitscope": "ship.zone",
"gitrepo": "npmci", "gitrepo": "npmci",
"shortDescription": "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"
]
} }
} }
} }

13685
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,8 +1,8 @@
{ {
"name": "@shipzone/npmci", "name": "@ship.zone/npmci",
"version": "4.0.9", "version": "4.1.32",
"private": false, "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", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module", "type": "module",
@@ -12,7 +12,8 @@
"scripts": { "scripts": {
"test": "tstest test/", "test": "tstest test/",
"build": "tsbuild --allowimplicitany && (npm run testVersion)", "build": "tsbuild --allowimplicitany && (npm run testVersion)",
"testVersion": "(cd test/assets/ && node ../../cli.js -v)" "testVersion": "(cd test/assets/ && node ../../cli.js -v)",
"buildDocs": "tsdoc"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@@ -25,37 +26,37 @@
}, },
"homepage": "https://gitlab.com/gitzone/npmci#README", "homepage": "https://gitlab.com/gitzone/npmci#README",
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.65", "@git.zone/tsbuild": "^2.1.84",
"@gitzone/tsrun": "^1.2.37", "@git.zone/tsrun": "^1.2.49",
"@gitzone/tstest": "^1.0.73", "@git.zone/tstest": "^1.0.77",
"@pushrocks/tapbundle": "^5.0.4", "@push.rocks/tapbundle": "^5.3.0",
"@types/node": "^18.8.3" "@types/node": "^22.7.9"
}, },
"dependencies": { "dependencies": {
"@apiglobal/typedrequest": "^2.0.10", "@api.global/typedrequest": "^3.1.10",
"@pushrocks/lik": "^6.0.0", "@push.rocks/lik": "^6.1.0",
"@pushrocks/npmextra": "^3.0.9", "@push.rocks/npmextra": "^5.0.23",
"@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.11",
"@pushrocks/smartdelay": "^2.0.13", "@push.rocks/smartdelay": "^3.0.5",
"@pushrocks/smartenv": "^5.0.3", "@push.rocks/smartenv": "^5.0.5",
"@pushrocks/smartfile": "^10.0.5", "@push.rocks/smartfile": "^11.0.21",
"@pushrocks/smartgit": "^3.0.0", "@push.rocks/smartgit": "^3.1.1",
"@pushrocks/smartlog": "^3.0.1", "@push.rocks/smartlog": "^3.0.7",
"@pushrocks/smartlog-destination-local": "^8.0.8", "@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": "^3.1.7", "@push.rocks/smartpromise": "^4.0.4",
"@pushrocks/smartrequest": "^2.0.11", "@push.rocks/smartrequest": "^2.0.18",
"@pushrocks/smartshell": "^2.0.30", "@push.rocks/smartshell": "^3.0.6",
"@pushrocks/smartsocket": "^2.0.7", "@push.rocks/smartsocket": "^2.0.22",
"@pushrocks/smartssh": "^2.0.0", "@push.rocks/smartssh": "^2.0.1",
"@pushrocks/smartstring": "^4.0.5", "@push.rocks/smartstring": "^4.0.8",
"@servezone/interfaces": "^1.0.3", "@serve.zone/api": "^1.2.1",
"@tsclass/tsclass": "^4.0.21", "@tsclass/tsclass": "^4.1.2",
"@types/through2": "^2.0.36", "@types/through2": "^2.0.38",
"through2": "^4.0.2" "through2": "^4.0.2"
}, },
"files": [ "files": [
@@ -72,5 +73,22 @@
], ],
"browserslist": [ "browserslist": [
"last 1 chrome versions" "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"
] ]
} }

5523
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

2
readme.hints.md Normal file
View File

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

542
readme.md
View File

@@ -1,112 +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)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage ## 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
``` ```
**Available options** #### Gitea CI
| setting | example | description | Lastly, for Gitea CI:
| -------------- | ----------------------------- | ------------------------------------------------------------------------------------------------- |
| 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. ```yaml
image: hosttoday/ht-docker-node:npmci
Use TypeScript for best in class instellisense. 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
## Contribution - step:
name: Build
image: hosttoday/ht-docker-node:npmci
commands:
- npmci docker build
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). :) - step:
name: Test
image: hosttoday/ht-docker-node:npmci
commands:
- npmci npm test
For further information read the linked docs at the top of this readme. - step:
name: Deploy
image: hosttoday/ht-docker-node:npmci
commands:
- npmci publish npm
- npmci docker push
```
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) ### 2. Handle Node Versions
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com) 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.'));
```
### 3. Handling npm and Yarn Tasks
`npmci` provides numerous utilities to streamline npm and yarn workflow tasks within a CI/CD pipeline.
```typescript
import { Npmci } from '@ship.zone/npmci';
async function manageNpmTasks() {
const npmciInstance = new Npmci();
await npmciInstance.start();
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
}
manageNpmTasks().then(() => console.log('Npm tasks handled successfully.'));
```
### 4. Docker Task Handling
`npmci` simplifies Docker operations, particularly in building, testing, and publishing Docker images.
**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

View File

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

View File

@@ -1,23 +1,26 @@
process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = '0'; 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'; import * as cloudlyConnectorMod from '../ts/connector.cloudly/cloudlyconnector.js';
tap.test('should be able to announce a container to cloudly', async () => { tap.test('should be able to announce a container to cloudly', async () => {
const cloudlyConnector = new cloudlyConnectorMod.CloudlyConnector(null); const cloudlyConnector = new cloudlyConnectorMod.CloudlyConnector(null);
await cloudlyConnector.announceDockerContainer({ await cloudlyConnector.announceDockerContainer(
{
registryUrl: 'registry.losssless.com', registryUrl: 'registry.losssless.com',
tag: 'testcontainer', tag: 'testcontainer',
version: 'x.x.x', version: 'x.x.x',
labels: [] labels: [],
}, 'cloudly.lossless.one') },
'cloudly.lossless.one'
);
}); });
tap.test('should close the program despite socket timeout', async (toolsArg) => { tap.test('should close the program despite socket timeout', async (toolsArg) => {
// TODO: remove when unreffed timeouts in webrequest have been solved. // TODO: remove when unreffed timeouts in webrequest have been solved.
toolsArg.delayFor(0).then(() => { toolsArg.delayFor(0).then(() => {
process.exit(); process.exit();
}) });
}) });
tap.start(); tap.start();

View File

@@ -1,9 +1,9 @@
import { tap, expect } from '@pushrocks/tapbundle'; import { tap, expect } from '@push.rocks/tapbundle';
import * as path from 'path'; 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.NPMTS_TEST = 'true';
process.env.NPMCI_URL_CLOUDLY = 'localhost' process.env.NPMCI_URL_CLOUDLY = 'localhost';
// set up environment // set up environment
process.env.CI_REPOSITORY_URL = 'https://yyyyyy:xxxxxxxx@gitlab.com/mygroup/myrepo.git'; process.env.CI_REPOSITORY_URL = 'https://yyyyyy:xxxxxxxx@gitlab.com/mygroup/myrepo.git';
@@ -19,22 +19,20 @@ process.cwd = () => {
return path.join(smartpath.get.dirnameFromImportMetaUrl(import.meta.url), 'assets/'); 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');
tap.preTask('should import npmci', async () => {
npmci = await import('../ts/index.js');
})
// ====== // ======
// Docker // 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 () => { tap.test('should return valid Dockerfiles', async () => {
const npmciInstance = new npmci.Npmci(); const npmciInstance = new npmci.Npmci();
await npmciInstance.start();
dockerfile1 = new npmci.Dockerfile(npmciInstance.dockerManager, { dockerfile1 = new npmci.Dockerfile(npmciInstance.dockerManager, {
filePath: './Dockerfile', filePath: './Dockerfile',
read: true, read: true,
@@ -49,8 +47,9 @@ tap.test('should return valid Dockerfiles', async () => {
tap.test('should read a directory of Dockerfiles', async () => { tap.test('should read a directory of Dockerfiles', async () => {
const npmciInstance = new npmci.Npmci(); const npmciInstance = new npmci.Npmci();
await npmciInstance.start();
return npmci.Dockerfile.readDockerfiles(npmciInstance.dockerManager).then( return npmci.Dockerfile.readDockerfiles(npmciInstance.dockerManager).then(
async (readDockerfilesArrayArg: npmci.Dockerfile[]) => { async (readDockerfilesArrayArg: npmciTypes.Dockerfile[]) => {
sortableArray = readDockerfilesArrayArg; sortableArray = readDockerfilesArrayArg;
return expect(readDockerfilesArrayArg[1].version).toEqual('sometag1'); return expect(readDockerfilesArrayArg[1].version).toEqual('sometag1');
} }
@@ -59,7 +58,7 @@ tap.test('should read a directory of Dockerfiles', async () => {
tap.test('should sort an array of Dockerfiles', async () => { tap.test('should sort an array of Dockerfiles', async () => {
return npmci.Dockerfile.sortDockerfiles(sortableArray).then( return npmci.Dockerfile.sortDockerfiles(sortableArray).then(
async (sortedArrayArg: npmci.Dockerfile[]) => { async (sortedArrayArg: npmciTypes.Dockerfile[]) => {
console.log(sortedArrayArg); console.log(sortedArrayArg);
} }
); );
@@ -67,6 +66,7 @@ tap.test('should sort an array of Dockerfiles', async () => {
tap.test('should build all Dockerfiles', async () => { tap.test('should build all Dockerfiles', async () => {
const npmciInstance = new npmci.Npmci(); const npmciInstance = new npmci.Npmci();
await npmciInstance.start();
return npmciInstance.dockerManager.handleCli({ return npmciInstance.dockerManager.handleCli({
_: ['docker', 'build'], _: ['docker', 'build'],
}); });
@@ -74,6 +74,7 @@ tap.test('should build all Dockerfiles', async () => {
tap.test('should test all Dockerfiles', async () => { tap.test('should test all Dockerfiles', async () => {
const npmciInstance = new npmci.Npmci(); const npmciInstance = new npmci.Npmci();
await npmciInstance.start();
return npmciInstance.dockerManager.handleCli({ return npmciInstance.dockerManager.handleCli({
_: ['docker', 'test'], _: ['docker', 'test'],
}); });
@@ -81,6 +82,7 @@ tap.test('should test all Dockerfiles', async () => {
tap.test('should test dockerfiles', async () => { tap.test('should test dockerfiles', async () => {
const npmciInstance = new npmci.Npmci(); const npmciInstance = new npmci.Npmci();
await npmciInstance.start();
return npmciInstance.dockerManager.handleCli({ return npmciInstance.dockerManager.handleCli({
_: ['docker', 'test'], _: ['docker', 'test'],
}); });
@@ -88,6 +90,7 @@ tap.test('should test dockerfiles', async () => {
tap.test('should login docker daemon', async () => { tap.test('should login docker daemon', async () => {
const npmciInstance = new npmci.Npmci(); const npmciInstance = new npmci.Npmci();
await npmciInstance.start();
return npmciInstance.dockerManager.handleCli({ return npmciInstance.dockerManager.handleCli({
_: ['docker', 'login'], _: ['docker', 'login'],
}); });
@@ -108,6 +111,7 @@ tap.test('should prepare SSH keys', async () => {
// ==== // ====
tap.test('should install a certain version of node', async () => { tap.test('should install a certain version of node', async () => {
const npmciInstance = new npmci.Npmci(); const npmciInstance = new npmci.Npmci();
await npmciInstance.start();
await npmciInstance.nodejsManager.handleCli({ await npmciInstance.nodejsManager.handleCli({
_: ['node', 'install', 'stable'], _: ['node', 'install', 'stable'],
}); });

View File

@@ -1,8 +1,8 @@
/** /**
* autocreated commitinfo by @pushrocks/commitinfo * autocreated commitinfo by @push.rocks/commitinfo
*/ */
export const commitinfo = { export const commitinfo = {
name: '@shipzone/npmci', name: '@ship.zone/npmci',
version: '4.0.9', version: '4.1.32',
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.'
} }

View File

@@ -33,7 +33,7 @@ export class CloudlyConnector {
); );
const response = await typedrequest.fire({ const response = await typedrequest.fire({
containerImageInfo: optionsArg containerImageInfo: optionsArg,
}); });
} }
} }

View File

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

View File

@@ -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');
}
}

View File

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

View File

@@ -77,20 +77,23 @@ export class NpmciDockerManager {
*/ */
public prepare = async () => { public prepare = async () => {
// Always login to GitLab Registry // Always login to GitLab Registry
if (!process.env.CI_BUILD_TOKEN || process.env.CI_BUILD_TOKEN === '') { if (process.env.GITLAB_CI) {
logger.log('error', 'No registry token specified by gitlab!'); console.log('gitlab ci detected');
if (!process.env.CI_JOB_TOKEN || process.env.CI_JOB_TOKEN === '') {
logger.log('error', 'Running in Gitlab CI, but no registry token specified by gitlab!');
process.exit(1); process.exit(1);
} }
this.npmciRegistryStorage.addRegistry( this.npmciRegistryStorage.addRegistry(
new DockerRegistry({ new DockerRegistry({
registryUrl: 'registry.gitlab.com', registryUrl: 'registry.gitlab.com',
username: 'gitlab-ci-token', username: 'gitlab-ci-token',
password: process.env.CI_BUILD_TOKEN, password: process.env.CI_JOB_TOKEN,
}) })
); );
}
// handle registries // handle registries
await plugins.smartparam.forEachMinimatch( await plugins.smartobject.forEachMinimatch(
process.env, process.env,
'NPMCI_LOGIN_DOCKER*', 'NPMCI_LOGIN_DOCKER*',
async (envString: string) => { async (envString: string) => {
@@ -176,4 +179,12 @@ export class NpmciDockerManager {
await this.prepare(); await this.prepare();
return await Dockerfile.readDockerfiles(this).then(Dockerfile.testDockerfiles); 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;
}
} }

View File

@@ -120,15 +120,19 @@ 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';
} }
versionString = versionString.replace(
'##version##',
dockerfileInstanceArg.npmciDockerManagerRef.npmciRef.npmciConfig.getConfig().projectInfo.npm.version
);
return versionString; return versionString;
} }
@@ -177,14 +181,17 @@ export class Dockerfile {
): Promise<string> { ): Promise<string> {
logger.log('info', 'checking for env vars to be supplied to the docker build'); logger.log('info', 'checking for env vars to be supplied to the docker build');
let buildArgsString: string = ''; let buildArgsString: string = '';
for (const key of Object.keys( for (const dockerArgKey of Object.keys(
npmciDockerManagerRef.npmciRef.npmciConfig.getConfig().dockerBuildargEnvMap npmciDockerManagerRef.npmciRef.npmciConfig.getConfig().dockerBuildargEnvMap
)) { )) {
const targetValue = const dockerArgOuterEnvVar =
process.env[ npmciDockerManagerRef.npmciRef.npmciConfig.getConfig().dockerBuildargEnvMap[dockerArgKey];
npmciDockerManagerRef.npmciRef.npmciConfig.getConfig().dockerBuildargEnvMap[key] logger.log(
]; 'note',
buildArgsString = `${buildArgsString} --build-arg ${key}="${targetValue}"`; `docker ARG "${dockerArgKey}" maps to outer env var "${dockerArgOuterEnvVar}"`
);
const targetValue = process.env[dockerArgOuterEnvVar];
buildArgsString = `${buildArgsString} --build-arg ${dockerArgKey}="${targetValue}"`;
} }
return buildArgsString; return buildArgsString;
} }
@@ -230,7 +237,7 @@ export class Dockerfile {
this.npmciDockerManagerRef.npmciRef.npmciEnv.repo.user + this.npmciDockerManagerRef.npmciRef.npmciEnv.repo.user +
'/' + '/' +
this.npmciDockerManagerRef.npmciRef.npmciEnv.repo.repo; 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.cleanTag = this.repo + ':' + this.version;
this.buildTag = this.cleanTag; this.buildTag = this.cleanTag;
@@ -276,9 +283,9 @@ export class Dockerfile {
registryUrl: this.pushTag, registryUrl: this.pushTag,
tag: this.buildTag, tag: this.buildTag,
labels: [], labels: [],
version: version: this.npmciDockerManagerRef.npmciRef.npmciConfig.getConfig().projectInfo.npm.version,
this.npmciDockerManagerRef.npmciRef.npmciConfig.getConfig().projectInfo.npm.version,
}); });
await this.npmciDockerManagerRef.npmciRef.npmciConfig.kvStorage.writeKey('latestPushedDockerTag', this.pushTag)
} }
/** /**

View File

@@ -26,7 +26,7 @@ export class DockerRegistry {
process.exit(1); process.exit(1);
return; return;
} }
const registryUrl = dockerRegexResultArray[0]; const registryUrl = dockerRegexResultArray[0].replace('https://', '').replace('http://', '');
const username = dockerRegexResultArray[1]; const username = dockerRegexResultArray[1];
const password = dockerRegexResultArray[2]; const password = dockerRegexResultArray[2];
return new DockerRegistry({ return new DockerRegistry({

View File

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

View File

@@ -54,11 +54,12 @@ export class NpmciNpmManager {
public async prepare() { public async prepare() {
const config = this.npmciRef.npmciConfig.getConfig(); const config = this.npmciRef.npmciConfig.getConfig();
let npmrcFileString: string = ''; let npmrcFileString: string = '';
await plugins.smartparam.forEachMinimatch( await plugins.smartobject.forEachMinimatch(
process.env, process.env,
'NPMCI_TOKEN_NPM*', 'NPMCI_TOKEN_NPM*',
(npmEnvArg: string) => { (npmEnvArg: string) => {
const npmRegistryUrl = npmEnvArg.split('|')[0]; const npmRegistryUrl = npmEnvArg.split('|')[0];
logger.log('ok', `found token for ${npmRegistryUrl}`);
let npmToken = npmEnvArg.split('|')[1]; let npmToken = npmEnvArg.split('|')[1];
if (npmEnvArg.split('|')[2] && npmEnvArg.split('|')[2] === 'plain') { if (npmEnvArg.split('|')[2] && npmEnvArg.split('|')[2] === 'plain') {
logger.log('ok', 'npm token not base64 encoded.'); logger.log('ok', 'npm token not base64 encoded.');
@@ -99,7 +100,7 @@ export class NpmciNpmManager {
let publishVerdaccioAsWell = false; let publishVerdaccioAsWell = false;
const config = this.npmciRef.npmciConfig.getConfig(); const config = this.npmciRef.npmciConfig.getConfig();
const availableRegistries: string[] = []; const availableRegistries: string[] = [];
await plugins.smartparam.forEachMinimatch( await plugins.smartobject.forEachMinimatch(
process.env, process.env,
'NPMCI_TOKEN_NPM*', 'NPMCI_TOKEN_NPM*',
(npmEnvArg: string) => { (npmEnvArg: string) => {

24
ts/mod_precheck/index.ts Normal file
View File

@@ -0,0 +1,24 @@
import * as plugins from './plugins.js';
import * as paths from '../npmci.paths.js';
import { logger } from '../npmci.logging.js';
import { Npmci } from '../npmci.classes.npmci.js';
export const handleCli = async (npmciRefArg: Npmci, argvArg: any) => {
logger.log('info', 'checking execution context');
const presentRunnerTags = process.env.CI_RUNNER_TAGS.split(',').map((stringArg) =>
stringArg.trim()
);
let allDesiredGitlabRunnerTagsPresent = true;
for (const desiredRunnerTag of npmciRefArg.npmciConfig.getConfig().gitlabRunnerTags) {
if (!presentRunnerTags.includes(desiredRunnerTag)) {
allDesiredGitlabRunnerTagsPresent = false;
logger.log(
'error',
`Desired runnerRag ${desiredRunnerTag} is missing in current execution context.`
);
}
}
if (!allDesiredGitlabRunnerTagsPresent) {
process.exit(1);
}
};

View File

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

View File

@@ -31,7 +31,7 @@ const notUndefined = (stringArg: string) => {
*/ */
export let prepare = async () => { export let prepare = async () => {
sshInstance = new plugins.smartssh.SshInstance(); // init ssh instance 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) { if (!process.env.NPMTS_TEST) {
sshInstance.writeToDisk(); sshInstance.writeToDisk();
} else { } else {

View File

@@ -7,7 +7,7 @@ const triggerValueRegex =
export let trigger = async () => { export let trigger = async () => {
logger.log('info', 'now running triggers'); 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) => { const evaluateTrigger = async (triggerEnvVarArg) => {

View File

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

View File

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

View File

@@ -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 // command
this.smartcli.addCommand('command').subscribe( this.smartcli.addCommand('command').subscribe(
async (argv) => { async (argv) => {
@@ -36,7 +47,7 @@ export class NpmciCli {
} }
); );
// command // git
this.smartcli.addCommand('git').subscribe( this.smartcli.addCommand('git').subscribe(
async (argvArg) => { async (argvArg) => {
await this.npmciRef.gitManager.handleCli(argvArg); await this.npmciRef.gitManager.handleCli(argvArg);
@@ -79,17 +90,16 @@ export class NpmciCli {
} }
); );
this.smartcli.addCommand('precheck').subscribe(async (argvArg) => {
const modPrecheck = await import('./mod_precheck/index.js');
await modPrecheck.handleCli(this.npmciRef, argvArg);
});
// trigger // trigger
this.smartcli.addCommand('ssh').subscribe( this.smartcli.addCommand('ssh').subscribe(async (argvArg) => {
async (argvArg) => {
const modSsh = await import('./mod_ssh/index.js'); const modSsh = await import('./mod_ssh/index.js');
await modSsh.handleCli(argvArg); await modSsh.handleCli(argvArg);
}, });
(err) => {
console.log(err);
process.exit(1);
}
);
// trigger // trigger
this.smartcli.addCommand('trigger').subscribe( this.smartcli.addCommand('trigger').subscribe(

View File

@@ -20,8 +20,14 @@ export interface INpmciOptions {
dockerRegistryRepoMap: { [key: string]: string }; dockerRegistryRepoMap: { [key: string]: string };
dockerBuildargEnvMap: { [key: string]: string }; dockerBuildargEnvMap: { [key: string]: string };
// gitlab
gitlabRunnerTags: string[];
// urls // urls
urlCloudly: string; urlCloudly: string;
// cloudron
cloudronAppName?: string;
} }
/** /**
@@ -38,10 +44,12 @@ export class NpmciConfig {
constructor(npmciRefArg: Npmci) { constructor(npmciRefArg: Npmci) {
this.npmciRef = npmciRefArg; this.npmciRef = npmciRefArg;
}
public async init() {
this.npmciNpmextra = new plugins.npmextra.Npmextra(paths.cwd); this.npmciNpmextra = new plugins.npmextra.Npmextra(paths.cwd);
this.kvStorage = new plugins.npmextra.KeyValueStore( this.kvStorage = new plugins.npmextra.KeyValueStore(
'custom', 'userHomeDir',
`${this.npmciRef.npmciEnv.repo.user}_${this.npmciRef.npmciEnv.repo.repo}` `${this.npmciRef.npmciEnv.repo.user}_${this.npmciRef.npmciEnv.repo.repo}`
); );
this.npmciQenv = new plugins.qenv.Qenv( this.npmciQenv = new plugins.qenv.Qenv(
@@ -57,12 +65,10 @@ export class NpmciConfig {
dockerRegistryRepoMap: {}, dockerRegistryRepoMap: {},
npmAccessLevel: 'private', npmAccessLevel: 'private',
npmRegistryUrl: 'registry.npmjs.org', npmRegistryUrl: 'registry.npmjs.org',
gitlabRunnerTags: [],
dockerBuildargEnvMap: {}, 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); this.configObject = this.npmciNpmextra.dataFor<INpmciOptions>('npmci', this.configObject);
} }

View File

@@ -9,7 +9,12 @@ export class NpmciEnv {
constructor(npmciRefArg: Npmci) { constructor(npmciRefArg: Npmci) {
this.npmciRef = npmciRefArg; this.npmciRef = npmciRefArg;
if (process.env.GITLAB_CI) {
this.repoString = process.env.CI_REPOSITORY_URL; this.repoString = process.env.CI_REPOSITORY_URL;
}
if (process.env.NPMCI_COMPUTED_REPOURL) {
this.repoString = process.env.NPMCI_COMPUTED_REPOURL;
}
if (!this.repoString) { if (!this.repoString) {
this.repoString = 'https://undefined:undefined@github.com/undefined/undefined.git'; this.repoString = 'https://undefined:undefined@github.com/undefined/undefined.git';
} }

View File

@@ -11,7 +11,7 @@ export class NpmciInfo {
this.npmciRef = npmciArg; 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}`);
} }
} }

View File

@@ -3,7 +3,10 @@ import * as plugins from './npmci.plugins.js';
export const cwd = process.cwd(); export const cwd = process.cwd();
// package paths // package paths
export const NpmciPackageRoot = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../'); export const NpmciPackageRoot = plugins.path.join(
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
'../'
);
export const NpmciPackageConfig = plugins.path.join(NpmciPackageRoot, './config.json'); export const NpmciPackageConfig = plugins.path.join(NpmciPackageRoot, './config.json');
// project paths // project paths

View File

@@ -4,36 +4,38 @@ import * as path from 'path';
export { path }; export { path };
// @apiglobal // @apiglobal
import * as typedrequest from '@apiglobal/typedrequest'; import * as typedrequest from '@api.global/typedrequest';
export { typedrequest }; export { typedrequest };
// @servezone // @servezone
import * as servezoneInterfaces from '@servezone/interfaces'; import * as servezoneApi from '@serve.zone/api';
export { servezoneInterfaces }; export { servezoneApi };
// @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 { export {
lik,
npmextra, npmextra,
projectinfo, projectinfo,
qenv, qenv,
@@ -44,7 +46,7 @@ export {
smartcli, smartcli,
smartlog, smartlog,
smartlogDestinationLocal, smartlogDestinationLocal,
smartparam, smartobject,
smartpath, smartpath,
smartpromise, smartpromise,
smartrequest, smartrequest,
@@ -57,9 +59,7 @@ export {
// @tsclass scope // @tsclass scope
import * as tsclass from '@tsclass/tsclass'; import * as tsclass from '@tsclass/tsclass';
export { export { tsclass };
tsclass
}
// third party // third party
import * as through2 from 'through2'; import * as through2 from 'through2';

View File

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