publish: create tag

Author: marwie

.github/workflows/test.yml

@@ -27,7 +27,7 @@ jobs:
             run: npm install
 
           - name: Run publish command
-            run: npx . publish "./test" --webhook "${{ secrets.DISCORD_WEBHOOK }}" --access-token "${{ secrets.NPM_TOKEN }}" --version+hash --tag github --version+tag
+            run: npx . publish "./test" --webhook "${{ secrets.DISCORD_WEBHOOK }}" --access-token "${{ secrets.NPM_TOKEN }}" --version+hash --tag github --version+tag --create-tag
 
           - name: Run publish without tag
             run: npx . publish "./test" --webhook "${{ secrets.DISCORD_WEBHOOK }}" --access-token "${{ secrets.NPM_TOKEN }}" --version+hash

index.js

@@ -44,6 +44,7 @@ program.command('publish', 'Publish npm package')
     .option("--tag <tag>", "NPM tag to use", { required: false, validator: program.STRING })
     .option("--version+hash", "Include hash in version (default: false)", { required: false, validator: program.BOOLEAN, default: false })
     .option("--version+tag", "Include tag in version (default: false)", { required: false, validator: program.BOOLEAN, default: false })
+    .option("--create-tag", "Create a git tag with the version (default: false)", { required: false, validator: program.BOOLEAN, default: false })
     .option("--webhook <webhook>", "Webhook URL to send notifications", { required: false, validator: program.STRING })
     .option("--access-token <access-token>", "NPM access token", { required: false, validator: program.STRING })
     .option("--dry-run", "Dry run mode, do not publish", { required: false, validator: program.BOOLEAN, default: false })
@@ -61,6 +62,7 @@ program.command('publish', 'Publish npm package')
             accessToken: options.accessToken?.toString() || null,
             useHashInVersion: options.versionHash === true, // default to false
             useTagInVersion: options.versionTag === true, // default to false
+            createGitTag: options.createTag === true, // default to false
             dryRun: options.dryRun === true,
             tag: tag,
             webhookUrl: options.webhook?.toString() || null,

src/publish.js

@@ -233,6 +233,20 @@ export async function publish(args) {
     logger.info(`♻ Restoring original package.json at ${packageJsonPath}`);
     writeFileSync(packageJsonPath, _originalPackageJson, 'utf-8');
 
+    if (args.createGitTag) {
+        const cmd = `git tag -a ${packageJson.version} -m "Published ${packageJson.version}"`;
+        logger.info(`Creating git tag with command: ${cmd}`);
+        const res = tryExecSync(cmd, {
+            cwd: packageDirectory,
+            env: env
+        });
+        if (!res.success) {
+            logger.error(`❌ Failed to create git tag: ${res.error}`);
+            if (webhook) {
+                await sendMessageToWebhook(webhook, `❌ **Failed to create git tag** \`${packageJson.version}\`: ${res.error}`);
+            }
+        }
+    }
 
     if (process.env.GITHUB_OUTPUT) {
         appendFileSync(process.env.GITHUB_OUTPUT, `package-version=${packageJson.version}\n`);

types/index.d.ts

@@ -27,6 +27,7 @@ export type PublishOptions = {
     tag: string | null | undefined;
     useHashInVersion: boolean;
     useTagInVersion: boolean;
+    createGitTag: boolean;
     dryRun: boolean;
     webhookUrl: string | null | undefined;
     overrideName: string | null | undefined;