feat: add option versionCmd #20

versionCmd can be used to dynamically set the version

Author: abichinger

README.md

@@ -94,6 +94,7 @@ Working examples using Github Actions can be found here:
 | ```gpgIdentity``` | str | ```null``` | When ```gpgSign``` is true, set the GPG identify to use when signing files. Leave empty to use the default identity.
 | ```envDir``` | string \| ```false``` | ```.venv``` | directory to create the virtual environment in, if set to `false` no environment will be created
 | ```installDeps``` | bool | ```true``` | wether to automatically install python dependencies
+| ```versionCmd``` | string | ```undefined``` | Run a custom command to update the version (e.g. `hatch version ${version}`). `srcDir` is used as working directory. `versionCmd` is required if the version is set [dynamically](https://packaging.python.org/en/latest/specifications/pyproject-toml/#dynamic)
 
 ## Development
 

lib/default-options.ts

@@ -47,4 +47,8 @@ export class DefaultConfig {
   public get installDeps() {
     return this.config.installDeps ?? true;
   }
+
+  public get versionCmd() {
+    return this.config.versionCmd;
+  }
 }

lib/prepare.ts

@@ -1,5 +1,6 @@
 import { Options } from 'execa';
 import fs from 'fs';
+import { template } from 'lodash';
 import os from 'os';
 import path from 'path';
 import type { Context } from './@types/semantic-release/index.js';
@@ -82,9 +83,8 @@ async function createVenv(envDir: string, options?: Options): Promise<Options> {
 
 async function prepare(pluginConfig: PluginConfig, context: Context) {
   const { logger, nextRelease } = context;
-  const { srcDir, setupPath, distDir, envDir, installDeps } = new DefaultConfig(
-    pluginConfig,
-  );
+  const { srcDir, setupPath, distDir, envDir, installDeps, versionCmd } =
+    new DefaultConfig(pluginConfig);
 
   if (nextRelease === undefined) {
     throw new Error('nextRelease is undefined');
@@ -112,10 +112,16 @@ async function prepare(pluginConfig: PluginConfig, context: Context) {
 
   const version = await normalizeVersion(nextRelease.version, execaOptions);
 
-  if (isLegacyBuildInterface(srcDir)) {
+  if (versionCmd) {
+    const cmd = template(versionCmd)({ version });
+    logger.log(`Running versionCmd: ${cmd}`);
+    const [file, ...args] = cmd.split(' ');
+    await assertExitCode(file, args, { ...execaOptions, cwd: srcDir }, 0);
+  } else if (isLegacyBuildInterface(srcDir)) {
     logger.log(`Set version to ${version} (setup.cfg)`);
     await setVersionPy(setupPath, version);
   } else {
+    logger.log(`Set version to ${version} (pyproject.toml)`);
     await setVersionToml(srcDir, version, execaOptions);
   }
 

lib/py/requirements.txt

@@ -3,4 +3,5 @@ build~=1.0
 setuptools~=68.2
 twine>=5.1.1,<6
 tomlkit~=0.12
-packaging~=24.0
+packaging~=24.0
+hatch~=1.13.0

lib/py/set_version.py

@@ -18,7 +18,7 @@
 # modifiy version (tomlkit will preserve comments)
 toml = parse(pyproject)
 if 'tool' in toml and 'poetry' in toml['tool']:
-    print(f'Poetry package detected')
+    print('Poetry package detected')
     toml['tool']['poetry']['version'] = args.version
 else:
     toml['project']['version'] = args.version

lib/types.ts

@@ -7,4 +7,5 @@ export interface PluginConfig {
   gpgIdentity?: string;
   envDir?: string | false;
   installDeps?: boolean;
+  versionCmd?: string;
 }

lib/verify.ts

@@ -3,6 +3,7 @@ import FormData from 'form-data';
 import fs from 'fs';
 import got from 'got';
 import path from 'path';
+import TOML from 'smol-toml';
 import { Context } from './@types/semantic-release/index.js';
 import { DefaultConfig } from './default-options.js';
 import { PluginConfig } from './types.js';
@@ -28,7 +29,8 @@ async function assertExitCode(
   }
   if (res.exitCode != exitCode) {
     throw Error(
-      `command: ${res.command}, exit code: ${res.exitCode}, expected: ${exitCode}`,
+      res.stderr +
+        `\ncommand: ${res.command}, exit code: ${res.exitCode}, expected: ${exitCode}`,
     );
   }
 }
@@ -79,11 +81,17 @@ function isLegacyBuildInterface(srcDir: string): boolean {
   return !fs.statSync(pyprojectPath).isFile;
 }
 
+function assertVersionCmd(pyproject: any, versionCmd?: string) {
+  const dynamic: string[] = pyproject.project?.dynamic ?? [];
+  if (dynamic.includes('version') && !versionCmd) {
+    throw Error(`'versionCmd' is required when using a dynamic version`);
+  }
+}
+
 async function verify(pluginConfig: PluginConfig, context: Context) {
   const { logger } = context;
-  const { srcDir, setupPath, pypiPublish, repoUrl } = new DefaultConfig(
-    pluginConfig,
-  );
+  const { srcDir, setupPath, pypiPublish, repoUrl, versionCmd } =
+    new DefaultConfig(pluginConfig);
 
   const execaOptions: Options = pipe(context);
 
@@ -109,6 +117,14 @@ async function verify(pluginConfig: PluginConfig, context: Context) {
 
     logger.log('Verify that version is not set in setup.py');
     await verifySetupPy(setupPath, execaOptions);
+  } else {
+    const pyprojectPath = path.join(srcDir, 'pyproject.toml');
+    const toml = fs.readFileSync(pyprojectPath, {
+      encoding: 'utf8',
+      flag: 'r',
+    });
+    const pyproject = TOML.parse(toml);
+    assertVersionCmd(pyproject, versionCmd);
   }
 }
 

package.json

@@ -11,6 +11,7 @@
   "private": false,
   "devDependencies": {
     "@semantic-release/git": "^10.0.1",
+    "@types/lodash": "^4.17.13",
     "@types/node": "^22.7.7",
     "@types/uuid": "^9.0.4",
     "@typescript-eslint/eslint-plugin": "^6.7.4",
@@ -37,7 +38,9 @@
   "dependencies": {
     "execa": "^9.4.1",
     "form-data": "^3.0.0",
-    "got": "^12.6.1"
+    "got": "^12.6.1",
+    "lodash": "^4.17.21",
+    "smol-toml": "^1.3.1"
   },
   "files": [
     "dist/*",

test/package.test.ts

@@ -1,16 +1,6 @@
-import { PassThrough } from 'stream';
 import { expect, test } from 'vitest';
 import { prepare, publish, verifyConditions } from '../lib/index.js';
-import { genPackage, hasPackage } from './util.js';
-
-class EndlessPassThrough extends PassThrough {
-  end(): this {
-    return this;
-  }
-  close() {
-    super.end();
-  }
-}
+import { genPackage, hasPackage, OutputAnalyzer } from './util.js';
 
 test('test semantic-release-pypi (pyproject.toml)', async () => {
   if (!process.env['TESTPYPI_TOKEN']) {
@@ -78,26 +68,52 @@ build-backend = "poetry.core.masonry.api"`;
     },
   });
 
-  const stream = new EndlessPassThrough();
-  context.stdout = stream;
-
-  let built = false;
-  stream.on('data', (bytes) => {
-    const str = bytes.toString('utf-8');
-    if (
-      str.includes('Successfully built') &&
-      str.includes('poetry_demo-1.0.0')
-    ) {
-      built = true;
-    }
+  const outputAnalyzer = new OutputAnalyzer({
+    built: ['Successfully built', 'poetry_demo-1.0.0'],
   });
+  context.stdout = outputAnalyzer.stream;
 
   await verifyConditions(config, context);
   await prepare(config, context);
   await publish(config, context);
 
-  expect(built).toEqual(true);
+  expect(outputAnalyzer.res.built).toEqual(true);
   expect(context.logger.log).toHaveBeenCalledWith(
     'Not publishing package due to requested configuration',
   );
 }, 60000);
+
+test('semantic-release-pypi (hatch, dynamic version)', async () => {
+  const pyproject = `[project]
+name = "hatch-demo"
+dynamic = ["version"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "hatch_demo/__init__.py"`;
+
+  const { config, context } = await genPackage({
+    legacyInterface: false,
+    config: { pypiPublish: false, versionCmd: 'hatch version ${version}' },
+    content: pyproject,
+    files: {
+      hatch_demo: {
+        '__init__.py': '__version__ = "0.0.0"\n',
+      },
+    },
+  });
+
+  const outputAnalyzer = new OutputAnalyzer({
+    built: ['Successfully built', 'hatch_demo-1.0.0'],
+  });
+  context.stdout = outputAnalyzer.stream;
+
+  await verifyConditions(config, context);
+  await prepare(config, context);
+  await publish(config, context);
+
+  expect(outputAnalyzer.res.built).toEqual(true);
+}, 60000);

test/prepare.test.ts

@@ -3,13 +3,14 @@ import {
   bDistPackage,
   createVenv,
   installPackages,
+  prepare,
   sDistPackage,
   setVersionPy,
   setVersionToml,
 } from '../lib/prepare.js';
 import { pipe, spawn } from '../lib/util.js';
 import { assertPackage } from '../lib/verify.js';
-import { genPackage } from './util.js';
+import { genPackage, OutputAnalyzer } from './util.js';
 
 describe('prepare: build functions', () => {
   const testCases = [
@@ -60,6 +61,23 @@ test('prepare: setVersionToml', async () => {
   ).resolves.toBe(undefined);
 });
 
+test('prepare: versionCmd', async () => {
+  const { pluginConfig, context } = genPackage({
+    legacyInterface: false,
+    config: {
+      versionCmd: 'echo Next version: ${version}',
+    },
+  });
+
+  const outputAnalyzer = new OutputAnalyzer({
+    executed: ['Next version: 1.0.0'],
+  });
+  context.stdout = outputAnalyzer.stream;
+
+  await prepare(pluginConfig, context);
+  expect(outputAnalyzer.res.executed).toBe(true);
+}, 60000);
+
 describe('prepare: installPackages', () => {
   const tests = [
     { name: 'system', opt: async () => ({}) },