@mlaursen/release-script 0.0.3 → 0.0.5

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/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}`);
@@ -21,8 +21,6 @@ export async function release(options) {
     exec("git add .changeset");
     const changeset = await getCurrentChangeset();
     exec("pnpm changeset version", { stdio: "inherit" });
-    // handle the first release
-    exec("git add CHANGELOG.md");
     exec("git add -u");
     await continueRelease();
     exec(`git commit -m "${versionMessage}"`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mlaursen/release-script",
   "type": "module",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "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>",