automate part of the release process

Author: ghazi-git

.release-it.ts

@@ -0,0 +1,32 @@
+import type { Config } from "release-it";
+
+export default {
+  hooks: {
+    "before:init": ["git pull", "npm run lint"],
+  },
+  // https://github.com/release-it/release-it/blob/main/docs/git.md
+  git: {
+    commit: true,
+    commitMessage: "Release v${version}",
+    tag: true,
+    tagName: "v${version}",
+    push: true,
+  },
+  // https://github.com/release-it/release-it/blob/main/docs/github-releases.md
+  github: {
+    release: true,
+    releaseName: "Release v${version}",
+  },
+  plugins: {
+    "@release-it/keep-a-changelog": {
+      // changes the version in the changelog file.
+      // Also, the addition of this plugin allows extraction of the version
+      // changes from the changelog files and their use in GitHub release notes
+      filename: "CHANGELOG.md",
+      addUnreleased: true,
+    },
+  },
+  npm: {
+    publish: false,
+  },
+} satisfies Config;

CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
-## [UNRELEASED]
+## [Unreleased]
 
 ### Added
 

README.md

@@ -160,10 +160,18 @@ npm run build
 
 ## Release Process
 
-- Add the version and date to the changelog `## [<version>] - <yyyy-mm-dd>` and keep `## [UNRELEASED]` at the top.
-- Set the version in `package.json`
-- Commit the changes and push a git tag `v<version>`.
-- Create a GitHub release with the same version and changes copied from the changelog.
+- [optional] Set env variable
+  `GITHUB_TOKEN` ([generate token](https://github.com/settings/tokens/new?scopes=repo&description=indexeddb-browser-github-release))
+- Run `npm run release`
+  - Pull the latest changes on main.
+  - Check for linting issues `npm run lint`.
+  - Set the version in `package.json`
+  - Add the version and date to the changelog `## [<version>] - <yyyy-mm-dd>` and keep `## [UNRELEASED]` at the top.
+  - Commit the changes and create a git tag `v<version>`.
+  - Push the local commit and tag to GitHub.
+  - Open the GitHub release page with the fields prepopulated. The release notes are copied from the changelog.
+  - Create the GitHub release, done automatically if the GITHUB_TOKEN env variable is set. Otherwise, a new release page
+    is opened in the browser with fields prepopulated.
 - Package the extension with `npm run build`.
 - Upload the packaged extension to the Chrome web store.