changelog-tool 0.6.0 → 0.7.0

package/changelog.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+0.7.0 (2023-02-14)
+------------------
+
+* The "release" command now automatically commits and and creates a git tag,
+  much like `npm version`
+
+
 0.6.0 (2023-02-14)
 ------------------
 

package/cli.mjs

@@ -3,7 +3,7 @@
 import { parseArgs } from 'node:util';
 import * as fs from 'node:fs/promises';
 import * as url from 'node:url';
-import { readPackageVersion, exists, calculateNextVersion } from './util.mjs';
+import { readPackageVersion, exists, calculateNextVersion, isGit, isGitClean, runCommand } from './util.mjs';
 import { Changelog, VersionLog, LogItem } from './changelog.mjs';
 import { parseFile } from './parse.mjs';
 import { execSync } from 'node:child_process';
@@ -236,13 +236,26 @@ async function release() {
   }
   lastVersion.date = new Date().toISOString().substr(0,10);
   console.log(`Releasing ${lastVersion.version}`);
+
+  const useGit = await isGit();
+
+  if (useGit) {
+    if (!await isGitClean()) {
+      throw new Error('Current git working directory is not clean. Please commit your changes first');
+    }
+  }
+
   await fs.writeFile(filename, changelog.toString());
   console.log(`${changelog.versions.length} changelogs saved to ${filename}`);
 
   if (await exists('package.json')) {
-    const command = `npm version "${lastVersion.version}" --no-git-tag-version`;
-    console.log(command);
-    execSync(command);
+    runCommand(
+      `npm version "${lastVersion.version}" --no-git-tag-version`
+    );
+  }
+  if (useGit) {
+    runCommand(`git add --all`);
+    runCommand(`git tag v${lastVersion.version}`);
   }
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "changelog-tool",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "A CLI tool for manipulating changelogs",
   "type": "module",
   "main": "index.mjs",

package/readme.md

@@ -88,3 +88,9 @@ npm version [version] --no-git-tag-version
 
 This command adjust the `version` field in `package.json` to match the latest
 changelog version.
+
+If the tool detects if this is a git directory, it will also:
+
+* Ensure that the working directory is clean.
+* Commit the changes.
+* Create a tag with `git tag v[version]`.

package/util.mjs

@@ -1,5 +1,7 @@
 // @ts-check
+import { execSync } from 'node:child_process';
 import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
 
 /**
  * Checks if a file exists
@@ -108,3 +110,44 @@ export function calculateNextVersion(prevVersion, changeType = 'patch') {
   return parts.join('.');
 
 }
+
+/**
+ * Returns true if we're in a git-powered directory
+ *
+ * @returns {Promise<boolean>}
+ */
+export async function isGit() {
+
+  let currentPath = process.cwd();
+  while(currentPath!=='/') {
+    if (await exists(path.join(currentPath,'.git'))) {
+      return true;
+    }
+    currentPath = path.dirname(currentPath);
+  }
+  return false;
+
+}
+
+/**
+ * @param {string} command
+ * @returns {string}
+ */
+export function runCommand(command) {
+
+  process.stderr.write(command + '\n');
+  return execSync(command).toString('utf-8');
+
+}
+
+/**
+ * Returns true if the current working directory is clean.
+ *
+ * @returns {boolean}
+ */
+export function isGitClean() {
+
+  const result = execSync('git status --porcelain=v1').toString('utf-8');
+  return result.trim().length === 0;
+
+}