fix(docs): update installation and configuration documentation and include the license file in published artifacts

This commit is contained in:
2026-05-09 12:33:44 +00:00
parent ec911832ed
commit 7cee6eb187
7 changed files with 2450 additions and 1184 deletions
+10 -9
View File
@@ -27,10 +27,10 @@ For reporting bugs, issues, or security vulnerabilities, please visit [community
```bash
# Global installation (recommended for CLI usage)
npm install -g @git.zone/tsdocker
pnpm add --global @git.zone/tsdocker
# Or project-local installation
pnpm install --save-dev @git.zone/tsdocker
pnpm add --save-dev @git.zone/tsdocker
```
## Quick Start
@@ -243,7 +243,8 @@ Every tsdocker invocation gets its own **session** with unique:
- **Session ID** — Random 8-char hex (override with `TSDOCKER_SESSION_ID`)
- **Registry port** — Dynamically allocated (override with `TSDOCKER_REGISTRY_PORT`)
- **Registry container** — Named `tsdocker-registry-<sessionId>`
- **Builder suffix** — In CI, the buildx builder gets a `-<sessionId>` suffix to prevent collisions
- **Builder suffix** — Local runs use a stable project hash; CI runs add the session ID to prevent collisions
- **Registry data path** — Local runs use `.nogit/docker-registry/`; CI runs use `.nogit/docker-registry/<sessionId>/`
This prevents resource conflicts when multiple CI jobs run tsdocker in parallel. Auto-detected CI systems:
@@ -254,7 +255,7 @@ This prevents resource conflicts when multiple CI jobs run tsdocker in parallel.
| `GITLAB_CI` | GitLab CI |
| `CI` | Generic CI |
In local dev, no suffix is added — keeping a persistent builder for faster rebuilds.
In local dev, the builder suffix is stable per project path, keeping a reusable builder while avoiding collisions between projects. In CI, the session ID is added so parallel jobs do not share builders or registry storage.
### 🔍 Docker Context & Topology Detection
@@ -557,7 +558,7 @@ tsdocker push
build-and-push:
stage: build
script:
- npm install -g @git.zone/tsdocker
- pnpm add --global @git.zone/tsdocker
- tsdocker push
variables:
DOCKER_REGISTRY_1: 'registry.gitlab.com|$CI_REGISTRY_USER|$CI_REGISTRY_PASSWORD'
@@ -568,7 +569,7 @@ build-and-push:
```yaml
- name: Build and Push
run: |
npm install -g @git.zone/tsdocker
pnpm add --global @git.zone/tsdocker
tsdocker login
tsdocker push
env:
@@ -580,7 +581,7 @@ build-and-push:
```yaml
- name: Build and Push
run: |
npm install -g @git.zone/tsdocker
pnpm add --global @git.zone/tsdocker
tsdocker push
env:
DOCKER_REGISTRY_1: 'gitea.example.com|${{ secrets.REGISTRY_USER }}|${{ secrets.REGISTRY_PASSWORD }}'
@@ -687,7 +688,7 @@ dist_ts
## License and Legal Information
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
@@ -699,7 +700,7 @@ Use of these trademarks must comply with Task Venture Capital GmbH's Trademark G
### Company Information
Task Venture Capital GmbH
Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany
For any legal inquiries or further information, please contact us via email at hello@task.vc.