@thisismanta/semantic-version 2.0.0-8 → 2.0.0

package/README.md

@@ -1,6 +1,4 @@
-Once installed, this package verifies your upcoming **Git commit messages** against the convention and automatically runs `npm version` after a commit if needed.
-
-## Git commit message convention
+Once installed, this package verifies your upcoming **Git commit messages** against the convention below.
 
 ```
 <type>[!]: <subject>
@@ -10,11 +8,36 @@ Where
 - `!` indicates that the commit contains breaking changes.
 - `<subject>` is the actual commit message where the first word must be written in lower cases.
 
-## Versioning
+---
+
+Additionally, you can run `npx auto-npm-version` on **GitHub Actions** to trigger `npm version` based on your commit messages and create a GitHub release (optional).
 
 |Commit message type|Post-commit command|
 |---|---|
 |`!`|`npm version major`|
 |`feat`|`npm version minor`|
 |`fix`|`npm version patch`|
-|Others|Does not run `npm version`|
+|Others|Does not run `npm version`|
+
+Here's an example of **GitHub Actions** workflow file:
+
+```yml
+on:
+  push:
+    branches: [master]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Ensure Git tags are fetched
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: 'package.json'
+          cache: npm
+      - run: npm ci # Install semantic-version as part of the dependencies
+      - run: npx auto-npm-version
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Make it possible to create a new release using GitHub API
+```

package/lib/auto-npm-version.js

@@ -37,7 +37,7 @@ async function main() {
         JSON.parse(await run('npm pkg get version')));
     (0, debug_1.debug)('lastVersion »', JSON.stringify(lastVersion));
     if (!lastVersion) {
-        throw new Error('Expect to have a valid "version" field in package.json.');
+        throw new Error('Could not find last version.');
     }
     const commits = (await run(`git log v${lastVersion}..HEAD --format=%H%s`))
         .split('\n')
@@ -75,13 +75,13 @@ async function main() {
         console.log('Exited without releasing a new version');
         return;
     }
-    const nextVersion = await run(`npm version --json --no-commit-hooks ${releaseType}`);
-    (0, debug_1.debug)('nextVersion »', nextVersion);
-    console.log(`Created version ${releaseType}`);
+    const nextVersion = semver_1.default.valid(await run(`npm version --json --no-commit-hooks ${releaseType}`));
+    (0, debug_1.debug)('nextVersion »', JSON.stringify(nextVersion));
+    console.log(`Created tag ${releaseType}`);
     await run(`git push --follow-tags origin`);
     console.log(`Pushed Git tags`);
-    if (semver_1.default.valid(nextVersion) && process.env.GITHUB_TOKEN) {
-        const commitGroups = {
+    if (nextVersion && process.env.GITHUB_TOKEN) {
+        const groups = {
             'BREAKING CHANGES': [],
             'Features': [],
             'Bug Fixes': [],
@@ -89,31 +89,31 @@ async function main() {
         };
         for (const commit of commits) {
             if (commit.breaking) {
-                commitGroups['BREAKING CHANGES'].push(commit);
+                groups['BREAKING CHANGES'].push(commit);
             }
             else if (commit.type === 'feat') {
-                commitGroups['Features'].push(commit);
+                groups['Features'].push(commit);
             }
             else if (commit.type === 'bug') {
-                commitGroups['Bug Fixes'].push(commit);
+                groups['Bug Fixes'].push(commit);
             }
             else {
-                commitGroups['Others'].push(commit);
+                groups['Others'].push(commit);
             }
         }
-        const releaseNote = Object.entries(commitGroups)
+        const releaseNote = Object.entries(groups)
             .filter(([title, commits]) => commits.length > 0)
             .map(([title, commits]) => `### ${title}\n\n` +
             commits.map(({ subject, hash }) => `- ${subject} (${hash})`).join('\n'))
             .join('\n\n');
         (0, debug_1.debug)('releaseNote »', releaseNote);
         const octokit = github.getOctokit(process.env.GITHUB_TOKEN);
-        github.context.payload.ref;
         // See https://octokit.github.io/rest.js/v19#repos-create-release
         const releaseRespond = await octokit.rest.repos.createRelease({
             ...github.context.repo,
-            tag_name: nextVersion,
+            tag_name: 'v' + nextVersion,
             body: releaseNote,
+            make_latest: true, // TODO: compare with the latest release
         });
         (0, debug_1.debug)('releaseRespond »', JSON.stringify(releaseRespond, null, 2));
         console.log('Created a new release on GitHub');

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@thisismanta/semantic-version",
-	"version": "2.0.0-8",
+	"version": "2.0.0",
 	"author": "Anantachai Saothong <thisismanta@gmail.com>",
 	"license": "ISC",
 	"engines": {