From ba4ed8d0cc837dc172d634cc3a1288b2d99d54a3 Mon Sep 17 00:00:00 2001 From: Pranava Swaroopa Date: Tue, 24 Mar 2026 18:46:07 +0000 Subject: [PATCH 1/6] Removed Node related CLI implementation --- bin/cli.js | 420 --------------------------------------------------- package.json | 9 -- 2 files changed, 429 deletions(-) delete mode 100644 bin/cli.js diff --git a/bin/cli.js b/bin/cli.js deleted file mode 100644 index 1d13d34..0000000 --- a/bin/cli.js +++ /dev/null @@ -1,420 +0,0 @@ -#!/usr/bin/env node - -import readline from 'readline'; -import fs from 'fs'; -import path from 'path'; -import { fileURLToPath } from 'url'; - -// Native ESM imports -import * as CORE from '../src/core.js'; - -const __filename = fileURLToPath(import.meta.url); -const __dirname = path.dirname(__filename); - -const VERSION = '1.0.0'; -const _ROOT = path.join(__dirname, '..'); - -// Initialize with shared config -const configPath = path.join(_ROOT, 'src', 'ros2_dockergen', 'data', 'config.json'); -const config = JSON.parse(fs.readFileSync(configPath, 'utf8')); -CORE.init(config); - -// ─── ANSI helpers (zero deps) ───────────────────────────────────────────────── - -const tty = process.stdout.isTTY; -const C = { - bold: s => tty ? `\x1b[1m${s}\x1b[0m` : s, - dim: s => tty ? `\x1b[2m${s}\x1b[0m` : s, - cyan: s => tty ? `\x1b[36m${s}\x1b[0m` : s, - green: s => tty ? `\x1b[32m${s}\x1b[0m` : s, - yellow: s => tty ? `\x1b[33m${s}\x1b[0m` : s, - magenta: s => tty ? `\x1b[35m${s}\x1b[0m` : s, - red: s => tty ? `\x1b[31m${s}\x1b[0m` : s, - underline: s => tty ? `\x1b[4m${s}\x1b[0m` : s, - gray: s => tty ? `\x1b[90m${s}\x1b[0m` : s, -}; - -// ─── --help / --version ─────────────────────────────────────────────────────── - -function printHelp() { - console.log(` -${C.bold('ros2-dockergen')} v${VERSION} -Generate a Dockerfile, docker-compose.yml and README for a ROS2 project. - -${C.bold('USAGE')} - ros2-dockergen Run the interactive wizard - ros2-dockergen --help Show this help message - ros2-dockergen --version Print the version number - -${C.bold('WIZARD STEPS')} - 1. ROS2 distro — Jazzy (Ubuntu 24.04), Humble (22.04), Kilted - 2. Base variant — ros-core / ros-base / desktop / desktop-full - 3. ROS2 packages — Nav2, MoveIt2, SLAM, RViz2, TurtleBot3, CUDA, … - 4. Dev tools — colcon, rosdep, cmake, git, tmux, zsh, x11, … - 5. User setup — root or non-root with custom username / UID - 6. Workspace path — absolute path inside the container - 7. Container name — used for docker-compose service name - 8. Output directory — where the generated files are written - -${C.bold('NAVIGATION')} - Enter Accept the shown default value - Numbers e.g. 1,3,5 Select items in a multi-choice list - a Select all items - n Select no items (skip) - q Quit the wizard at any prompt — no files are written - -${C.bold('OUTPUT')} - Dockerfile Multi-stage image definition - docker-compose.yml Service definition with volumes, env, GPU/SSH/X11 - README.md Quick-start guide for the generated setup - -${C.bold('EXAMPLES')} - # Basic run - ros2-dockergen - - # Install from a cloned repo and run - ./install.sh - ros2-dockergen -`); -} - -function printVersion() { - console.log(VERSION); -} - -const args = process.argv.slice(2); -if (args.includes('--help') || args.includes('-h')) { printHelp(); process.exit(0); } -if (args.includes('--version') || args.includes('-v')) { printVersion(); process.exit(0); } - -// ─── Quit signal ────────────────────────────────────────────────────────────── - -class QuitSignal extends Error { constructor() { super('quit'); this.name = 'QuitSignal'; } } - -function quit() { - _rl.close(); - console.log(C.yellow('\n Wizard cancelled — no files were written.')); - process.exit(0); -} - -// ─── Prompt utilities ───────────────────────────────────────────────────────── - -const _rl = readline.createInterface({ - input: process.stdin, - output: process.stdout, - terminal: process.stdout.isTTY, -}); -const _lineQueue = []; -const _waiters = []; -let _rlClosed = false; - -_rl.on('line', line => { - if (_waiters.length) _waiters.shift()(line); - else _lineQueue.push(line); -}); -_rl.on('close', () => { - _rlClosed = true; - while (_waiters.length) _waiters.shift()(null); -}); - -function _readLine() { - return new Promise(resolve => { - if (_lineQueue.length) return resolve(_lineQueue.shift()); - if (_rlClosed) return resolve(null); - _waiters.push(resolve); - }); -} - -async function ask(prompt, defaultVal = '') { - const hint = defaultVal ? C.dim(` [${defaultVal}]`) : ''; - const qhint = C.gray(' (q to quit)'); - process.stdout.write(`${prompt}${hint}${qhint} › `); - const line = await _readLine(); - if (line === null) throw new QuitSignal(); - const answer = line.trim(); - if (answer.toLowerCase() === 'q') throw new QuitSignal(); - return answer || defaultVal; -} - -async function selectOne(stepLabel, purpose, choices) { - console.log(`\n${C.bold(stepLabel)}`); - console.log(C.dim(` ${purpose}`)); - console.log(''); - choices.forEach((c, i) => { - console.log(` ${C.cyan(String(i + 1).padStart(2) + '.')} ${c.name}`); - }); - console.log(''); - while (true) { - let raw; - try { raw = await ask(C.dim(` Enter 1–${choices.length}`), '1'); } - catch (e) { if (e instanceof QuitSignal) quit(); throw e; } - const idx = parseInt(raw, 10) - 1; - if (idx >= 0 && idx < choices.length) return choices[idx].value; - console.log(C.red(` ✗ Please enter a number between 1 and ${choices.length}`)); - } -} - -async function selectMany(stepLabel, purpose, choices) { - const defaults = choices.map((c, i) => c.checked ? i + 1 : null).filter(Boolean); - console.log(`\n${C.bold(stepLabel)}`); - console.log(C.dim(` ${purpose}`)); - console.log(''); - choices.forEach((c, i) => { - const bullet = c.checked ? C.green('●') : C.dim('○'); - console.log(` ${bullet} ${C.cyan(String(i + 1).padStart(2) + '.')} ${c.name}`); - }); - console.log(''); - console.log(C.dim(' ● = selected by default')); - console.log(C.dim(' Enter numbers separated by commas e.g. 1,4,7')); - console.log(C.dim(' a = select all n = select none Enter = keep defaults')); - console.log(''); - while (true) { - let raw; - try { raw = await ask(C.dim(' Selection'), defaults.length ? defaults.join(',') : 'n'); } - catch (e) { if (e instanceof QuitSignal) quit(); throw e; } - if (raw.toLowerCase() === 'a') return choices.map(c => c.value); - if (raw.toLowerCase() === 'n') return []; - const nums = raw.split(',').map(s => parseInt(s.trim(), 10)); - if (nums.every(n => !isNaN(n) && n >= 1 && n <= choices.length)) { - return [...new Set(nums)].map(n => choices[n - 1].value); - } - console.log(C.red(` ✗ Use comma-separated numbers 1–${choices.length}, 'a', or 'n'`)); - } -} - -async function confirm(question, def = false) { - const hint = def ? 'Y/n' : 'y/N'; - let raw; - try { raw = await ask(`${C.bold(question)} ${C.dim(`[${hint}]`)}`, def ? 'y' : 'n'); } - catch (e) { if (e instanceof QuitSignal) quit(); throw e; } - return raw.toLowerCase().startsWith('y'); -} - -async function input(stepLabel, purpose, defaultVal, validate) { - if (purpose) { - console.log(`\n${C.bold(stepLabel)}`); - console.log(C.dim(` ${purpose}`)); - } - while (true) { - let raw; - try { raw = await ask(purpose ? '' : C.bold(stepLabel), defaultVal); } - catch (e) { if (e instanceof QuitSignal) quit(); throw e; } - if (validate) { - const err = validate(raw); - if (err !== true) { console.log(C.red(` ✗ ${err}`)); continue; } - } - return raw; - } -} - -// ─── Choice definitions from CORE ───────────────────────────────────────────── - -function getDistroChoices() { - return CORE.getDistros().map(d => { - const rec = d.recommended ? ' (recommended)' : ''; - return { name: `${d.label.padEnd(8)} — Ubuntu ${d.ubuntu} LTS${rec}`, value: d.value }; - }); -} - -function getVariantChoices() { - return CORE.getVariants().map(v => ({ - name: `${v.label.padEnd(13)} ${v.description}`, - value: v.value - })); -} - -function getPackageChoices() { - return CORE.getRosPackageChoices().map(p => ({ - name: `${p.label.padEnd(16)} ${p.description}`, - value: p.value - })); -} - -function getToolChoices() { - return CORE.getToolChoices().map(t => ({ - name: `${t.label.padEnd(11)} ${t.description}`, - value: t.value, - checked: t.default - })); -} - -// ─── Step counter ───────────────────────────────────────────────────────────── - -const TOTAL_STEPS = 8; -let currentStep = 0; -function step(title) { - currentStep++; - const bar = C.cyan(`[${currentStep}/${TOTAL_STEPS}]`); - const spacer = C.cyan('─'.repeat(52)); - console.log(`\n${spacer}`); - console.log(`${bar} ${C.bold(title)}`); - console.log(spacer); -} - -// ─── Summary ────────────────────────────────────────────────────────────────── - -function printSummary(cfg, absOut) { - const { distro, variant, packages, tools, containerName, workspace, userType, username } = cfg; - const pkgsSet = new Set(packages); - const hasCuda = pkgsSet.has('cuda') || pkgsSet.has('tensorrt'); - - console.log(`\n${C.cyan('─'.repeat(56))}`); - console.log(C.bold(' 📋 Configuration summary')); - console.log(C.cyan('─'.repeat(56))); - console.log(` ${C.dim('Distro ')} ${C.green(distro)} / ${C.green(variant)}`); - console.log(` ${C.dim('User ')} ${userType === 'root' ? C.yellow('root') : C.green(username)}`); - console.log(` ${C.dim('Workspace')} ${workspace}`); - console.log(` ${C.dim('Container')} ${containerName}`); - if (hasCuda) console.log(` ${C.dim('GPU ')} ${C.magenta('CUDA / NVIDIA enabled')}`); - if (packages.length) console.log(` ${C.dim('Packages ')} ${packages.join(', ')}`); - if (tools.length) console.log(` ${C.dim('Tools ')} ${tools.join(', ')}`); - console.log(C.cyan('─'.repeat(56))); - console.log(''); - console.log(` ${C.bold('Files written to')} ${C.underline(absOut)}`); - console.log(` ${C.green('✔')} Dockerfile`); - console.log(` ${C.green('✔')} docker-compose.yml`); - console.log(` ${C.green('✔')} README.md`); - console.log(''); - console.log(C.bold(' 🚀 Next steps')); - console.log(` ${C.cyan(`cd ${absOut}`)}`); - console.log(` ${C.cyan('docker compose build')}`); - console.log(` ${C.cyan('docker compose up -d')}`); - console.log(` ${C.cyan(`docker exec -it ${containerName} bash`)}`); - console.log(''); -} - -// ─── Main wizard ────────────────────────────────────────────────────────────── - -async function main() { - console.log(''); - console.log(C.cyan('╔══════════════════════════════════════════════════════╗')); - console.log(C.cyan('║') + C.bold(' 🤖 ROS2 Docker Generator CLI v' + VERSION + ' ') + C.cyan('║')); - console.log(C.cyan('║') + C.dim(' Generate Dockerfiles & Compose files for ROS2 ') + C.cyan('║')); - console.log(C.cyan('╚══════════════════════════════════════════════════════╝')); - console.log(''); - console.log(C.dim(' This wizard will ask you 8 questions and generate:')); - console.log(C.dim(' • Dockerfile — ready to build')); - console.log(C.dim(' • docker-compose.yml — ready to run')); - console.log(C.dim(' • README.md — quick-start guide')); - console.log(''); - console.log(C.dim(' Type q at any prompt to cancel without writing files.')); - console.log(C.dim(' Run ros2-dockergen --help for full usage guide.')); - - step('ROS2 Distribution'); - const distro = await selectOne( - 'Which ROS2 distro do you want to use?', - 'This determines the base Docker image and available package versions.', - getDistroChoices() - ); - - step('Base Image Variant'); - const variant = await selectOne( - 'Which image variant?', - 'Larger variants include more tools but produce bigger images.', - getVariantChoices() - ); - - step('ROS2 Packages'); - const packages = await selectMany( - 'Which ROS2 packages should be installed?', - 'These are installed via apt inside the image. Select none to skip.', - getPackageChoices() - ); - - step('Developer Tools'); - const tools = await selectMany( - 'Which developer tools should be included?', - 'Pre-checked items are recommended for most ROS2 workflows.', - getToolChoices() - ); - - step('Container User'); - const userType = await selectOne( - 'Run the container as:', - 'Non-root is safer and matches your host UID to avoid file permission issues.', - [ - { name: 'Non-root user (recommended — avoids file permission issues)', value: 'user' }, - { name: 'Root (simpler, but not recommended for development)', value: 'root' }, - ] - ); - - let username = 'ros', uid = 1000; - if (userType === 'user') { - username = await input( - 'Username inside the container', - 'Used to create the Linux user account in the image.', - 'ros', - v => /^[a-z_][a-z0-9_-]{0,30}$/.test(v) || 'Use lowercase letters, digits, _ or - (max 31 chars)' - ); - const rawUid = await input( - 'UID for the user', - 'Should match your host UID to avoid volume permission issues (run `id -u` to check).', - '1000', - v => /^\d+$/.test(v) || 'Must be a positive integer' - ); - uid = parseInt(rawUid, 10) || 1000; - } - - step('Workspace Path'); - const defaultWs = userType === 'root' ? '/root/ros2_ws' : `/home/${username}/ros2_ws`; - const workspace = await input( - 'Workspace path inside the container', - 'Absolute path where your ROS2 workspace will live (mounted from host).', - defaultWs, - v => v.startsWith('/') || 'Must be an absolute path starting with /' - ); - - step('Container Name'); - const containerName = await input( - 'Container / service name', - 'Used as the docker-compose service name and the container hostname.', - `ros2-${distro}`, - v => /^[a-z0-9][a-z0-9_-]*$/.test(v) || 'Use lowercase letters, digits, _ or - (must start with a letter/digit)' - ); - - step('Output Directory'); - const outputDir = await input( - 'Where should the files be written?', - 'Directory will be created if it does not exist. Relative paths are resolved from the current directory.', - `./${containerName}`, - null - ); - - const cfg = { - distro, variant, - packages, tools, - userType, username, uid, - workspace, containerName, - }; - - const absOut = path.resolve(outputDir); - try { - if (!fs.existsSync(absOut)) fs.mkdirSync(absOut, { recursive: true }); - fs.writeFileSync(path.join(absOut, 'Dockerfile'), CORE.buildDockerfile(cfg), 'utf8'); - fs.writeFileSync(path.join(absOut, 'docker-compose.yml'), CORE.buildCompose(cfg), 'utf8'); - fs.writeFileSync(path.join(absOut, 'README.md'), CORE.buildReadme(cfg), 'utf8'); - } catch (err) { - console.error(C.red(`\n ✗ Could not write files: ${err.message}`)); - process.exit(1); - } - - printSummary(cfg, absOut); - - const show = await confirm(' Print Dockerfile to terminal now?', false); - if (show) { - console.log(''); - console.log(C.cyan('─'.repeat(56))); - console.log(C.bold(' Dockerfile')); - console.log(C.cyan('─'.repeat(56))); - console.log(fs.readFileSync(path.join(absOut, 'Dockerfile'), 'utf8')); - } - - _rl.close(); -} - -main().catch(err => { - if (err instanceof QuitSignal || err.code === 'ERR_USE_AFTER_CLOSE') { - quit(); - } - console.error(C.red('\n ✗ Unexpected error: ' + (err.message || err.stack || err))); - process.exit(1); -}); \ No newline at end of file diff --git a/package.json b/package.json index e52051d..d6162f5 100644 --- a/package.json +++ b/package.json @@ -3,16 +3,7 @@ "version": "1.0.2", "description": "CLI tool to generate ROS2 Dockerfiles and docker-compose files interactively", "type": "module", - "bin": { - "ros2-dockergen": "./bin/cli.js" - }, - "scripts": { - "start": "node bin/cli.js" - }, "dependencies": {}, - "engines": { - "node": ">=18.0.0" - }, "keywords": [ "ros2", "docker", From aeb4e1ae05ee2471ce419f43dbc16d4b7c41dd4e Mon Sep 17 00:00:00 2001 From: Pranava Swaroopa Date: Tue, 24 Mar 2026 19:05:54 +0000 Subject: [PATCH 2/6] verified and added tests for version consistency --- .github/workflows/ci.yml | 17 ++++- index.html | 2 +- src/ros2_dockergen/data/config.json | 2 +- tests/test_version.py | 98 +++++++++++++++++++++++++++++ 4 files changed, 116 insertions(+), 3 deletions(-) create mode 100644 tests/test_version.py diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1144a71..840c87f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -83,6 +83,19 @@ jobs: - 'index.html' - 'README.md' + # ── Version Consistency ────────────────────────────────────── + version-check: + name: "Version Consistency" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.12' + - name: Run Version Check + run: | + PYTHONPATH=src python3 tests/test_version.py + # ── Base image — runs per distro ──────────────────────────── # Re-runs when generate.js changes or on workflow_dispatch. # Humble and Jazzy are tested independently because their @@ -279,6 +292,7 @@ jobs: if: always() needs: - changes + - version-check - base-humble - base-humble-desktop - base-jazzy @@ -294,7 +308,8 @@ jobs: steps: - name: Check results run: | - declare -A results + results[changes]="${{ needs.changes.result }}" + results[version-check]="${{ needs.version-check.result }}" results[base-humble]="${{ needs.base-humble.result }}" results[base-humble-desktop]="${{ needs.base-humble-desktop.result }}" results[base-jazzy]="${{ needs.base-jazzy.result }}" diff --git a/index.html b/index.html index 6c80dc9..f71aa31 100644 --- a/index.html +++ b/index.html @@ -1926,7 +1926,7 @@

Your ROS2 Docker
Environment,
- ROS2 Docker Generator v1.0 · Built for the ROS2 community · Files generated entirely in your + ROS2 Docker Generator v1.0.2 · Built for the ROS2 community · Files generated entirely in your browser — nothing sent to any server
diff --git a/src/ros2_dockergen/data/config.json b/src/ros2_dockergen/data/config.json index 7ef4ce7..c6e634c 100644 --- a/src/ros2_dockergen/data/config.json +++ b/src/ros2_dockergen/data/config.json @@ -1,7 +1,7 @@ { "_comment": "ros2-dockergen shared configuration — consumed by both core.js (web) and core.py (CLI). Do not encode logic in either consumer; encode it here as rules.", - "version": "1.0.1", + "version": "1.0.2", "distros": { "jazzy": { diff --git a/tests/test_version.py b/tests/test_version.py new file mode 100644 index 0000000..03a9546 --- /dev/null +++ b/tests/test_version.py @@ -0,0 +1,98 @@ +#!/usr/bin/env python3 +import json +import sys +import re +from pathlib import Path + +try: + import tomllib +except ImportError: + # Fallback for Python < 3.11 if needed, but the environment has 3.12 + import pip + pip.main(['install', 'tomli']) + import tomli as tomllib + +ROOT = Path(__file__).parent.parent +SRC = ROOT / "src" +sys.path.insert(0, str(SRC)) + +from ros2_dockergen.core import GeneratorCore + +def test_versions(): + print("Checking version consistency...") + + # 1. Read pyproject.toml (Source of Truth) + pyproject_path = ROOT / "pyproject.toml" + with open(pyproject_path, "rb") as f: + pyproject = tomllib.load(f) + version = pyproject["project"]["version"] + print(f" pyproject.toml: {version}") + + # 2. Check config.json + config_path = SRC / "ros2_dockergen" / "data" / "config.json" + with open(config_path, "r") as f: + config = json.load(f) + config_version = config["version"] + print(f" config.json: {config_version}") + + if config_version != version: + print(f" ✗ Version mismatch! {config_version} != {version}") + sys.exit(1) + + # 3. Check package.json + package_path = ROOT / "package.json" + if package_path.exists(): + with open(package_path, "r") as f: + package = json.load(f) + package_version = package["version"] + print(f" package.json: {package_version}") + if package_version != version: + print(f" ✗ Version mismatch! {package_version} != {version}") + sys.exit(1) + + # 4. Check index.html (partial match for vX.Y.Z) + index_path = ROOT / "index.html" + if index_path.exists(): + content = index_path.read_text() + # We expect at least one occurrence of the version string + if f"v{version}" not in content: + print(f" ✗ index.html does not contain v{version}") + # We'll be lenient if it's just v1.0 + # Let's check if there are ANY old versions left + old_versions = re.findall(r"v1\.0\.[01]", content) + if old_versions: + print(f" ✗ found old versions in index.html: {set(old_versions)}") + sys.exit(1) + print(" ✓ index.html OK (uses abbreviated v1.0)") + else: + print(f" index.html: {version}") + + # 5. Verify generated Dockerfile header + core = GeneratorCore(config) + sample_config = { + "distro": "humble", + "variant": "ros-base", + "packages": [], + "tools": ["colcon"], + "user_type": "root", + "username": "root", + "uid": 0, + "workspace": "/ros2_ws", + "container_name": "test" + } + dockerfile = core.build_dockerfile(sample_config) + header_match = re.search(r"Generated by ros2-dockergen v([\d\.]+)", dockerfile) + if not header_match: + print(" ✗ Could not find version header in generated Dockerfile") + sys.exit(1) + + gen_version = header_match.group(1) + print(f" Generated DF: {gen_version}") + if gen_version != version: + print(f" ✗ Generated version mismatch! {gen_version} != {version}") + sys.exit(1) + + print("\n✅ All versions are consistent!") + +if __name__ == "__main__": + test_versions() From d86e928a5f545bcaa377ec73f064777dc101dd46 Mon Sep 17 00:00:00 2001 From: Pranava Swaroopa Date: Tue, 24 Mar 2026 19:27:26 +0000 Subject: [PATCH 3/6] added automatic versioning and version update script for manual, and added it in the publish pipeline --- .github/workflows/publish.yml | 1 + index.html | 19 ++++++++ pyproject.toml | 9 +++- src/ros2_dockergen/data/config.json | 28 +++++------ tests/sync_version.py | 42 ++++++++++++++++ tests/test_version.py | 76 +++++++++++++---------------- 6 files changed, 118 insertions(+), 57 deletions(-) create mode 100644 tests/sync_version.py diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 00b1dbe..242965a 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -25,6 +25,7 @@ jobs: pip install -e . - name: Run tests run: | + python3 tests/test_version.py python3 tests/test_parity.py build: diff --git a/index.html b/index.html index f71aa31..2259ca1 100644 --- a/index.html +++ b/index.html @@ -2247,6 +2247,25 @@

Your ROS2 Docker
Environment, { + const txt = el.textContent.trim(); + if (txt === 'v1.0' || txt === 'v1.0.2') el.textContent = `v${ver}`; + }); + document.querySelectorAll('.nav-badge').forEach(el => { + if (el.textContent.includes('v1.0')) { + el.textContent = el.textContent.replace(/v1\.0(\.2)?/, `v${ver}`); + } + }); + document.querySelectorAll('.footer-text').forEach(el => { + if (el.textContent.includes('v1.0')) { + el.textContent = el.textContent.replace(/v1\.0(\.2)?/, `v${ver}`); + } + }); + console.log('Core initialized! Building initial files...'); generateFiles(); diff --git a/pyproject.toml b/pyproject.toml index 2c15cee..8ac4f8e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,10 @@ [build-system] -requires = ["hatchling"] +requires = ["hatchling", "hatch-regex"] build-backend = "hatchling.build" [project] name = "ros2-dockergen" -version = "1.0.2" +dynamic = ["version"] description = "Interactive CLI wizard for generating ROS2 Docker environments" readme = "README.md" requires-python = ">=3.10" @@ -28,6 +28,11 @@ Homepage = "https://github.com/ppswaroopa/ros2-dockergen" Repository = "https://github.com/ppswaroopa/ros2-dockergen" "Bug Tracker" = "https://github.com/ppswaroopa/ros2-dockergen/issues" +[tool.hatch.version] +source = "regex" +path = "src/ros2_dockergen/data/config.json" +pattern = '"version": "(?P[^"]+)"' + [project.scripts] ros2-dockergen = "ros2_dockergen.cli:main" diff --git a/src/ros2_dockergen/data/config.json b/src/ros2_dockergen/data/config.json index c6e634c..9e6bcec 100644 --- a/src/ros2_dockergen/data/config.json +++ b/src/ros2_dockergen/data/config.json @@ -1,8 +1,6 @@ { "_comment": "ros2-dockergen shared configuration — consumed by both core.js (web) and core.py (CLI). Do not encode logic in either consumer; encode it here as rules.", - "version": "1.0.2", - "distros": { "jazzy": { "label": "Jazzy", @@ -29,7 +27,6 @@ "recommended": false } }, - "variants": { "ros-core": { "label": "ros-core", @@ -51,10 +48,11 @@ "description": "Desktop + extra simulation and sensor packages", "base_image": "osrf/ros:{distro}-desktop", "_comment": "OSRF does not publish a desktop-full tag; we use desktop as FROM and install desktop-full on top", - "extra_apt": ["ros-{distro}-desktop-full"] + "extra_apt": [ + "ros-{distro}-desktop-full" + ] } }, - "ros_packages": { "nav2": { "label": "Nav2", @@ -86,7 +84,10 @@ "ros-{distro}-gazebo-ros-pkgs", "ros-{distro}-gazebo-ros2-control" ], - "skip_on_distros": ["jazzy", "kilted"], + "skip_on_distros": [ + "jazzy", + "kilted" + ], "_skip_reason": "Gazebo Classic is EOL on Ubuntu 24.04 and above" }, "gz_sim": { @@ -112,8 +113,12 @@ "ros-{distro}-turtlebot3-msgs" ], "extra_apt_on_distros": { - "distros": ["humble"], - "apt": ["ros-{distro}-turtlebot3-simulations"] + "distros": [ + "humble" + ], + "apt": [ + "ros-{distro}-turtlebot3-simulations" + ] }, "_extra_apt_reason": "turtlebot3-simulations only exists for Humble; Jazzy/Kilted dropped it", "env": { @@ -192,7 +197,6 @@ "_comment": "No apt packages; presence triggers nvidia/cuda base image substitution" } }, - "tools": { "colcon": { "label": "colcon", @@ -356,22 +360,18 @@ "apt": [] } }, - "system_apt_always": [ "software-properties-common", "apt-transport-https", "ca-certificates" ], - "ros_build_tools_always": [ "python3-rosinstall-generator" ], - "cuda_base_image": "nvidia/cuda:{cuda_version}-devel-{ubuntu_image_suffix}", - "cuda_ros_install_apt": [ "curl", "gnupg2", "lsb-release" ] -} +} \ No newline at end of file diff --git a/tests/sync_version.py b/tests/sync_version.py new file mode 100644 index 0000000..0c2b122 --- /dev/null +++ b/tests/sync_version.py @@ -0,0 +1,42 @@ +#!/usr/bin/env python3 +import json +from pathlib import Path +import sys + +def sync(): + root = Path(__file__).parent.parent + config_path = root / "src" / "ros2_dockergen" / "data" / "config.json" + package_path = root / "package.json" + + if not config_path.exists(): + print(f"Error: {config_path} not found") + sys.exit(1) + + with open(config_path, "r") as f: + config = json.load(f) + + version = config.get("version") + if not version: + print("Error: No version found in config.json") + sys.exit(1) + + print(f"Master version: {version}") + + # Sync package.json + if package_path.exists(): + with open(package_path, "r") as f: + package = json.load(f) + + if package.get("version") != version: + print(f"Updating package.json: {package['version']} -> {version}") + package["version"] = version + with open(package_path, "w") as f: + json.dump(package, f, indent=2) + f.write("\n") + else: + print("package.json is already in sync.") + + print("Sync complete!") + +if __name__ == "__main__": + sync() diff --git a/tests/test_version.py b/tests/test_version.py index 03a9546..db04ee4 100644 --- a/tests/test_version.py +++ b/tests/test_version.py @@ -4,14 +4,6 @@ import re from pathlib import Path -try: - import tomllib -except ImportError: - # Fallback for Python < 3.11 if needed, but the environment has 3.12 - import pip - pip.main(['install', 'tomli']) - import tomli as tomllib - ROOT = Path(__file__).parent.parent SRC = ROOT / "src" sys.path.insert(0, str(SRC)) @@ -19,53 +11,55 @@ from ros2_dockergen.core import GeneratorCore def test_versions(): - print("Checking version consistency...") + print("Checking version consistency (Source of Truth: config.json)...") - # 1. Read pyproject.toml (Source of Truth) - pyproject_path = ROOT / "pyproject.toml" - with open(pyproject_path, "rb") as f: - pyproject = tomllib.load(f) - version = pyproject["project"]["version"] - print(f" pyproject.toml: {version}") - - # 2. Check config.json + # 1. Read config.json (New Source of Truth) config_path = SRC / "ros2_dockergen" / "data" / "config.json" + if not config_path.exists(): + print(f" ✗ config.json not found at {config_path}") + sys.exit(1) + with open(config_path, "r") as f: config = json.load(f) - config_version = config["version"] - print(f" config.json: {config_version}") + version = config.get("version") + if not version: + print(" ✗ No version found in config.json") + sys.exit(1) + print(f" config.json: {version}") + + # 2. Check pyproject.toml (should be dynamic) + pyproject_path = ROOT / "pyproject.toml" + with open(pyproject_path, "r") as f: + pyproject_content = f.read() - if config_version != version: - print(f" ✗ Version mismatch! {config_version} != {version}") + if 'dynamic = ["version"]' not in pyproject_content: + print(" ✗ pyproject.toml is not configured for dynamic versioning") sys.exit(1) + if 'source = "regex"' not in pyproject_content or 'path = "src/ros2_dockergen/data/config.json"' not in pyproject_content: + print(" ✗ pyproject.toml hatch-regex configuration is missing or incorrect") + sys.exit(1) + print(f" pyproject.toml: Dynamic") - # 3. Check package.json + # 3. Check package.json (should match config.json) package_path = ROOT / "package.json" if package_path.exists(): with open(package_path, "r") as f: package = json.load(f) - package_version = package["version"] - print(f" package.json: {package_version}") + package_version = package.get("version") + print(f" package.json: {package_version}") if package_version != version: - print(f" ✗ Version mismatch! {package_version} != {version}") + print(f" ✗ Metadata mismatch! package.json={package_version} != config.json={version}") + print(" Run ./tests/sync_version.py to fix this.") sys.exit(1) - # 4. Check index.html (partial match for vX.Y.Z) + # 4. Check index.html dynamic logic index_path = ROOT / "index.html" if index_path.exists(): content = index_path.read_text() - # We expect at least one occurrence of the version string - if f"v{version}" not in content: - print(f" ✗ index.html does not contain v{version}") - # We'll be lenient if it's just v1.0 - # Let's check if there are ANY old versions left - old_versions = re.findall(r"v1\.0\.[01]", content) - if old_versions: - print(f" ✗ found old versions in index.html: {set(old_versions)}") - sys.exit(1) - print(" ✓ index.html OK (uses abbreviated v1.0)") - else: - print(f" index.html: {version}") + if 'const ver = config.version || "1.0";' not in content: + print(" ✗ index.html is missing dynamic version injection logic") + sys.exit(1) + print(" index.html: Dynamic") # 5. Verify generated Dockerfile header core = GeneratorCore(config) @@ -87,12 +81,12 @@ def test_versions(): sys.exit(1) gen_version = header_match.group(1) - print(f" Generated DF: {gen_version}") + print(f" Generated DF: {gen_version}") if gen_version != version: - print(f" ✗ Generated version mismatch! {gen_version} != {version}") + print(f" ✗ Generated version mismatch! v{gen_version} != v{version}") sys.exit(1) - print("\n✅ All versions are consistent!") + print("\nAll versions are consistent or are dynamic!") if __name__ == "__main__": test_versions() From d0d01cf0d06717d9b827793e9f127852601cded6 Mon Sep 17 00:00:00 2001 From: Pranava Swaroopa Date: Wed, 25 Mar 2026 17:55:46 +0000 Subject: [PATCH 4/6] prepare for release v1.1 --- .github/workflows/publish.yml | 10 ++++++++-- CHANGELOG.md | 15 +++++++++++++++ package.json | 2 +- src/ros2_dockergen/data/config.json | 2 +- 4 files changed, 25 insertions(+), 4 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 242965a..9792162 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -34,6 +34,7 @@ jobs: runs-on: ubuntu-latest permissions: id-token: write # Mandatory for Trusted Publishing + contents: write # Mandatory for GitHub Releases steps: - uses: actions/checkout@v4 - name: Set up Python @@ -47,6 +48,11 @@ jobs: - name: Publish to PyPI uses: pypa/gh-action-pypi-publish@release/v1 with: - # No token needed when using Trusted Publishing (OIDC) - # You MUST enable this in PyPI Project Settings first. print-hash: true + - name: Create GitHub Release + uses: softprops/action-gh-release@v2 + with: + files: dist/* + generate_release_notes: true + draft: false + prerelease: false diff --git a/CHANGELOG.md b/CHANGELOG.md index 374ba19..2297ddb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [1.1.0] - 2026-03-25 + +### Added +- Centralized project versioning using `config.json` as the single source of truth. +- Integrated `hatch-regex` for dynamic versioning in `pyproject.toml`. +- Added a comprehensive version consistency test suite (`tests/test_version.py`). +- Added `tests/sync_version.py` for automated version management. +- Added GitHub Actions for automated publishing to GitHub Releases. + +### Changed +- Refactored `index.html` and CLI to dynamically consume version from `config.json`. + +### Removed +- Legacy Node-based CLI implementation in favor of the Python-based CLI. + ## [1.0.2] - 2026-03-24 ### Added diff --git a/package.json b/package.json index d6162f5..619abd8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ros2-dockergen", - "version": "1.0.2", + "version": "1.1.0", "description": "CLI tool to generate ROS2 Dockerfiles and docker-compose files interactively", "type": "module", "dependencies": {}, diff --git a/src/ros2_dockergen/data/config.json b/src/ros2_dockergen/data/config.json index 9e6bcec..f84987a 100644 --- a/src/ros2_dockergen/data/config.json +++ b/src/ros2_dockergen/data/config.json @@ -1,6 +1,6 @@ { "_comment": "ros2-dockergen shared configuration — consumed by both core.js (web) and core.py (CLI). Do not encode logic in either consumer; encode it here as rules.", - "version": "1.0.2", + "version": "1.1.0", "distros": { "jazzy": { "label": "Jazzy", From c40fe1016d64591a4ddffab5610d2974a7fea73c Mon Sep 17 00:00:00 2001 From: Pranava Swaroopa Date: Wed, 25 Mar 2026 18:20:58 +0000 Subject: [PATCH 5/6] CI Pipeline correction and added Readme badge for CI --- CI/generate.js | 2 +- README.md | 11 +++++++---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/CI/generate.js b/CI/generate.js index 0958f47..26c59be 100644 --- a/CI/generate.js +++ b/CI/generate.js @@ -27,7 +27,7 @@ const userType = getArg('usertype', 'user'); // Changed from 'custom' to match c // ── Load Config & Init Core ─────────────────────────────────── const _ROOT = path.join(__dirname, '..'); -const configPath = path.join(_ROOT, 'data', 'config.json'); +const configPath = path.join(_ROOT, 'src', 'ros2_dockergen', 'data', 'config.json'); const configData = JSON.parse(fs.readFileSync(configPath, 'utf8')); CORE.init(configData); diff --git a/README.md b/README.md index 5ebdcd5..e51716b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # 🤖 ros2-dockergen -[![PyPI version](https://img.shields.io/pypi/v/ros2-dockergen.svg)](https://pypi.org/project/ros2-dockergen/) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) -[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/) -[![Web UI](https://img.shields.io/badge/Web-Interactive_UI-00ff88.svg)](https://ppswaroopa.github.io/ros2-dockergen/) +

+ CI + PyPI version + License: MIT + Python 3.10+ + Web UI +


From 6a262742ab907960ce6b3b29dd4e7b3c4a0e0061 Mon Sep 17 00:00:00 2001 From: Pranava Swaroopa Date: Thu, 26 Mar 2026 01:51:15 +0000 Subject: [PATCH 6/6] version synchronized with additional scaffolding --- index.html | 25 +++++++------------------ tests/sync_version.py | 33 +++++++++++++++++++++++++++++++++ tests/test_version.py | 28 +++++++++++++++++++++++++--- 3 files changed, 65 insertions(+), 21 deletions(-) diff --git a/index.html b/index.html index 2259ca1..e16a0af 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ - ROS2 Docker Generator v1.0 — Get Robotics Running Fast + ROS2 Docker Generator v1.1.0 — Get Robotics Running Fast @@ -1091,10 +1091,10 @@

-
v1.0 · Humble · Jazzy · Kilted
+
v1.1.0 · Humble · Jazzy · Kilted
Your ROS2 Docker
Environment,
- ROS2 Docker Generator v1.0.2 · Built for the ROS2 community · Files generated entirely in your + ROS2 Docker Generator v1.1.0 · Built for the ROS2 community · Files generated entirely in your browser — nothing sent to any server
@@ -2249,21 +2249,10 @@

Your ROS2 Docker
Environment, { - const txt = el.textContent.trim(); - if (txt === 'v1.0' || txt === 'v1.0.2') el.textContent = `v${ver}`; - }); - document.querySelectorAll('.nav-badge').forEach(el => { - if (el.textContent.includes('v1.0')) { - el.textContent = el.textContent.replace(/v1\.0(\.2)?/, `v${ver}`); - } - }); - document.querySelectorAll('.footer-text').forEach(el => { - if (el.textContent.includes('v1.0')) { - el.textContent = el.textContent.replace(/v1\.0(\.2)?/, `v${ver}`); - } + document.querySelectorAll('.app-version-text').forEach(el => { + el.textContent = `v${ver}`; }); console.log('Core initialized! Building initial files...'); diff --git a/tests/sync_version.py b/tests/sync_version.py index 0c2b122..8c4a587 100644 --- a/tests/sync_version.py +++ b/tests/sync_version.py @@ -35,6 +35,39 @@ def sync(): f.write("\n") else: print("package.json is already in sync.") + + # Sync index.html + index_path = root / "index.html" + if index_path.exists(): + import re + content = index_path.read_text() + + # 1. Update + new_content = re.sub( + r'<title>ROS2 Docker Generator v[\d\.]+ — Get Robotics Running Fast', + f'ROS2 Docker Generator v{version} — Get Robotics Running Fast', + content + ) + + # 2. Update all elements with class="app-version-text" + new_content = re.sub( + r'(class="app-version-text"[^>]*>v)[\d\.]+', + f'\\g<1>{version}', + new_content + ) + + # 3. Update the fallback 'const ver' in JS + new_content = re.sub( + r'const ver = config\.version \|\| "[\d\.]+";', + f'const ver = config.version || "{version}";', + new_content + ) + + if content != new_content: + print(f"Updating index.html static version strings to: {version}") + index_path.write_text(new_content) + else: + print("index.html is already in sync.") print("Sync complete!") diff --git a/tests/test_version.py b/tests/test_version.py index db04ee4..71bf769 100644 --- a/tests/test_version.py +++ b/tests/test_version.py @@ -52,14 +52,36 @@ def test_versions(): print(" Run ./tests/sync_version.py to fix this.") sys.exit(1) - # 4. Check index.html dynamic logic + # 4. Check index.html dynamic logic and static versions index_path = ROOT / "index.html" if index_path.exists(): content = index_path.read_text() - if 'const ver = config.version || "1.0";' not in content: + if 'const ver = config.version ||' not in content: print(" ✗ index.html is missing dynamic version injection logic") sys.exit(1) - print(" index.html: Dynamic") + + # Check static versions have been correctly synced + title_expected = f"ROS2 Docker Generator v{version} — Get Robotics Running Fast" + js_expected = f'const ver = config.version || "{version}";' + + if title_expected not in content or js_expected not in content: + print(f" ✗ index.html has out-of-sync or JS fallback! Expected v{version}.") + print(" Run ./tests/sync_version.py to fix this.") + sys.exit(1) + + # Verify all .app-version-text spans match the version + static_mentions = re.findall(r'class="app-version-text"[^>]*>v([\d\.]+)<', content) + if not static_mentions: + print(" ✗ Could not find any .app-version-text elements in index.html to verify.") + sys.exit(1) + + for found_version in static_mentions: + if found_version != version: + print(f" ✗ index.html has stale static version 'v{found_version}'. Expected 'v{version}'.") + print(" Run ./tests/sync_version.py to fix this.") + sys.exit(1) + + print(" index.html: Dynamic + Static strings in sync") # 5. Verify generated Dockerfile header core = GeneratorCore(config)