Semantic versioning implementation

[alelom]

Closes #1

[Copilot]

Pull request overview

Adds an optional --version flow that can resolve the next PEP 440 version automatically via semantic-release (dry-run) to support both repo-level publishing and subfolder/monorepo publishing.

Changes:

• Added a Node.js get-next-version.cjs helper to compute the next version using semantic-release (with optional path-filtering and per-package tags for subfolders).
• Updated the CLI to make --version optional and to invoke the resolver when a version is required (subfolder builds or publishing).
• Documented the new auto-versioning mode and its prerequisites in the README.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
scripts/get-next-version.cjs	New repo-level helper script to compute next version via semantic-release.
src/python_package_folder/scripts/get-next-version.cjs	Packaged copy of the helper script intended for installed usage.
src/python_package_folder/python_package_folder.py	CLI integration for resolving --version automatically when needed.
README.md	Documents auto version resolution requirements and usage.
.cursor/plans/optional_version_+_semantic-release_efed88a6.plan.md	Design/implementation plan for the feature.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The formatting check is configured with continue-on-error: true, and tests/test_linting.py skips the formatter check in CI. Together this means formatting regressions won’t fail CI, so ruff format --check becomes advisory only. If formatting should be enforced, remove continue-on-error (or re-enable the test in CI).

Suggested change

continue-on-error: true

[Copilot]

This script appears duplicated in two locations (scripts/get-next-version.cjs and src/python_package_folder/scripts/get-next-version.cjs) with the same contents. Keeping two sources in sync is error-prone; consider making one the single source of truth (e.g., keep it only under src/python_package_folder/scripts/ and drop the root copy, or generate/copy it during packaging/dev) so future edits don’t diverge.

Suggested change

	/**
	* Get next version using semantic-release.
	*
	* This script runs semantic-release in dry-run mode to determine the next version
	* for a package. It supports both subfolder builds (per-package tags) and main
	* package builds (repo-level tags).
	*
	* Usage:
	* node scripts/get-next-version.cjs <project_root> [subfolder_path] [package_name]
	*
	* Args:
	* - project_root: Root directory of the project (absolute or relative path)
	* - subfolder_path: Optional. Path to subfolder relative to project_root (for Workflow 1)
	* - package_name: Optional. Package name for subfolder builds (for per-package tags)
	*
	* Output:
	* - Version string (e.g., "1.2.3") if a release is determined
	* - "none" if semantic-release determines no release is needed
	* - Exits with non-zero code on error
	*/
	const path = require('path');
	const fs = require('fs');
	// Parse command line arguments
	const args = process.argv.slice(2);
	if (args.length < 1) {
	console.error('Error: project_root is required');
	console.error('Usage: node get-next-version.cjs <project_root> [subfolder_path] [package_name]');
	process.exit(1);
	}
	const projectRoot = path.resolve(args[0]);
	const subfolderPath = args[1] || null;
	const packageName = args[2] || null;
	// Validate argument combination: both-or-neither for subfolder builds
	if ((subfolderPath !== null && packageName === null) || (subfolderPath === null && packageName !== null)) {
	console.error('Error: subfolder_path and package_name must be provided together (both or neither).');
	console.error('Usage: node get-next-version.cjs <project_root> [subfolder_path] [package_name]');
	process.exit(1);
	}
	// Check if project root exists
	if (!fs.existsSync(projectRoot)) {
	console.error(`Error: Project root does not exist: ${projectRoot}`);
	process.exit(1);
	}
	// Determine if this is a subfolder build
	const isSubfolderBuild = subfolderPath !== null && packageName !== null;
	const workingDir = isSubfolderBuild
	? path.resolve(projectRoot, subfolderPath)
	: projectRoot;
	// Check if working directory exists
	if (!fs.existsSync(workingDir)) {
	console.error(`Error: Working directory does not exist: ${workingDir}`);
	process.exit(1);
	}
	// For subfolder builds, ensure package.json exists with correct name
	let tempPackageJson = null;
	let backupCreatedByScript = false;
	let fileCreatedByScript = false;
	let originalPackageJsonContent = null; // Track original content for restoration
	/**
	* Thin wrapper for the canonical get-next-version script.
	*
	* This script simply forwards all arguments to
	* src/python_package_folder/scripts/get-next-version.cjs
	* to avoid maintaining duplicate implementations.
	*/
	const path = require('path');
	const { spawnSync } = require('child_process');
	// Resolve path to the canonical script relative to this file.
	const canonicalScriptPath = path.resolve(
	__dirname,
	'..',
	'src',
	'python_package_folder',
	'scripts',
	'get-next-version.cjs'
	);
	const args = process.argv.slice(2);
	const result = spawnSync(process.execPath, [canonicalScriptPath, ...args], {
	stdio: 'inherit',
	});
	// Propagate exit code (default to 1 on failure to spawn).
	process.exit(result.status === null || result.status === undefined ? 1 : result.status);