@mlaursen/release-script 0.0.4 → 0.0.6

package/README.md

@@ -49,7 +49,7 @@ await release({
   // If there is a custom build command for releases. `build` is the default
   // buildCommand: "build",
 
-  // An optional flag if the build step should be skipped. `false` by default
+  // An optional flag if the build step should be skipped. `!buildCommand` by default
   // skipBuild: process.argv.includes("--skip-build"),
 
   // This is useful for monorepos where only a single Github release needs to
@@ -98,3 +98,17 @@ Finally, run the release script whenever a new release should go out:
 ```sh
 pnpm release
 ```
+
+## Alpha Releases
+
+Use the changesets api to enter the pre-release flow:
+
+```sh
+pnpm changeset enter pre
+```
+
+Once ready to do a real release:
+
+```sh
+pnpm changeset exit pre
+```

package/dist/continueRelease.js

@@ -1,6 +1,6 @@
 import confirm from "@inquirer/confirm";
 export async function continueRelease() {
-    const confirmed = confirm({ message: "Continue the release?" });
+    const confirmed = await confirm({ message: "Continue the release?" });
     if (!confirmed) {
         process.exit(1);
     }

package/dist/createRelease.d.ts

@@ -5,11 +5,15 @@ export interface ConfigurableCreateReleaseOptions {
      */
     owner?: string;
     /**
-     * The `.env` file to load to get the `GITHUB_TOKEN` environment variable.
+     * The `.env` file to load to get the {@link tokenName} environment variable.
      *
      * @defaultValue `".env.local"`
      */
     envPath?: string;
+    /**
+     * @defaultValue `"GITHUB_RELEASE_TOKEN"`
+     */
+    tokenName?: string;
 }
 export interface CreateReleaseOptions extends ConfigurableCreateReleaseOptions {
     body: string;

package/dist/createRelease.js

@@ -2,9 +2,9 @@ import confirm from "@inquirer/confirm";
 import { Octokit } from "@octokit/core";
 import dotenv from "dotenv";
 export async function createRelease(options) {
-    const { body, override, owner = "mlaursen", repo, prerelease, envPath = ".env.local", tagName, } = options;
+    const { body, override, owner = "mlaursen", repo, prerelease, envPath = ".env.local", tagName, tokenName = "GITHUB_RELEASE_TOKEN", } = options;
     dotenv.config({ path: envPath, override, quiet: true });
-    const octokit = new Octokit({ auth: process.env.GITHUB_TOKEN });
+    const octokit = new Octokit({ auth: process.env[tokenName] });
     try {
         const response = await octokit.request("POST /repos/{owner}/{repo}/releases", {
             owner,

package/dist/release.d.ts

@@ -1,9 +1,21 @@
 import { ConfigurableCreateReleaseOptions } from "./createRelease.js";
 export interface ReleaseOptions extends ConfigurableCreateReleaseOptions {
+    /**
+     * @defaultValue `!buildCommand`
+     */
     skipBuild?: boolean;
+    /**
+     * @defaultValue `"clean"`
+     */
     cleanCommand?: string;
+    /**
+     * @defaultValue `"build"`
+     */
     buildCommand?: string;
     mainPackage?: string;
+    /**
+     * @defaultValue `"build(version): version package"`
+     */
     versionMessage?: string;
     getTagName?: () => Promise<string>;
 }

package/dist/release.js

@@ -9,7 +9,7 @@ const exec = (command, opts) => {
     execSync(command, opts);
 };
 export async function release(options) {
-    const { owner, repo, envPath, skipBuild, cleanCommand = "clean", buildCommand = "build", mainPackage, getTagName = createGetTagName(mainPackage), versionMessage = "build(version): version package", } = options;
+    const { owner, repo, envPath, cleanCommand = "clean", buildCommand = "build", skipBuild = !buildCommand, mainPackage, getTagName = createGetTagName(mainPackage), versionMessage = "build(version): version package", } = options;
     const pkgManager = await getPackageManager();
     if (!skipBuild) {
         exec(`${pkgManager} ${cleanCommand}`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mlaursen/release-script",
   "type": "module",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "The release script I normally use for packages I publish to npm",
   "repository": "https://github.com/mlaursen/release-script.git",
   "author": "Mikkel Laursen <mlaursen03@gmail.com>",
@@ -22,20 +22,20 @@
     "npm"
   ],
   "dependencies": {
-    "@changesets/cli": "^2.29.5",
-    "@inquirer/confirm": "^5.1.14",
-    "@inquirer/input": "^4.2.1",
-    "@inquirer/rawlist": "^4.1.5",
-    "@octokit/core": "^7.0.3",
-    "dotenv": "^17.2.1"
+    "@changesets/cli": "^2.29.7",
+    "@inquirer/confirm": "^5.1.19",
+    "@inquirer/input": "^4.2.5",
+    "@inquirer/rawlist": "^4.1.9",
+    "@octokit/core": "^7.0.6",
+    "dotenv": "^17.2.3"
   },
   "devDependencies": {
-    "@types/node": "^22.15.29",
+    "@types/node": "^24.9.2",
     "husky": "^9.1.7",
-    "lint-staged": "^16.1.2",
+    "lint-staged": "^16.2.6",
     "prettier": "^3.6.2",
-    "tsx": "^4.20.3",
-    "typescript": "^5.8.3"
+    "tsx": "^4.20.6",
+    "typescript": "^5.9.3"
   },
   "publishConfig": {
     "access": "public"
@@ -46,8 +46,8 @@
     ]
   },
   "volta": {
-    "node": "22.17.1",
-    "pnpm": "10.13.1"
+    "node": "24.11.0",
+    "pnpm": "10.20.0"
   },
   "scripts": {
     "typecheck": "tsc --noEmit",