@sebbo2002/semantic-release-jsr 1.0.0-develop.8 → 1.0.0-develop.9

package/README.md

@@ -5,20 +5,20 @@
 Small `semantic-release` plugin, which adjusts the version in the `jsr.json` file and executes 
 `jsr publish` to publish the module on jsr.io as well.
 
-## 🚨 This is still Work in Progress!
+## 🚨 Work in Progress
+
+This plugin is still very fresh and therefore anything but stable or reliable. Please only use it 
+if you don't mind failing releases.
 
-| Step               | Description                                     |
-| ------------------ |-------------------------------------------------|
-| `verifyConditions` | Runs `jsr publish --dry-run` to test your setup |
-| `prepare`          | Update the `jsr.json` / `deno.json` files       |
-| `publish`          | Run final `jsr publish` command                 |
 
 ## 📦 Install
 
 ```bash
-$ npm install -D @sebbo2002/semantic-release-jsr
+# Install via npm
+$ npm install -D @sebbo2002/semantic-release-jsr@next
 ```
 
+
 ## 🔧 Usage
 
 The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):
@@ -34,8 +34,18 @@ The plugin can be configured in the [**semantic-release** configuration file](ht
 ```
 
 Please do not forget to set the `id-token` permission in your GitHub action so that `jsr publish`
-can access the OIDC ID token for authentication.
+can access the OIDC ID token for authentication. Optionally, some options can be passed to the 
+plugin, which are documented [here](https://sebbo2002.github.io/semantic-release-jsr/develop/reference/interfaces/PluginConfig.html).
+
+
+## ⚙️ Steps
 
+| Step                 | Description                                                                               |
+|----------------------|-------------------------------------------------------------------------------------------|
+| `verifyConditions`   | Runs `jsr publish --dry-run` to test your setup. Also downloads the deno binary if required. |
+| `prepare`            | Update the `jsr.json` / `deno.json` files                                                 |
+| `publish`            | Run final `jsr publish` command                                                           |
+| `fail` / `success`   | Remove the temporary folder                                                               |
 
 ## 🙆🏼‍♂️ Copyright and license
 

package/dist/index.d.cts

@@ -2,9 +2,25 @@ import { PublishOptions } from 'jsr';
 import { NextRelease, VerifyConditionsContext, PrepareContext, PublishContext, SuccessContext, FailContext, VerifyReleaseContext } from 'semantic-release';
 
 interface PluginConfig {
+    /**
+     * Working directory given to `jsr publish`.
+     * Defaults to current directory.
+     */
     cwd?: string;
+    /**
+     * Path to package.json.
+     * Defaults to `cwd` + `/package.json` if it exists.
+     */
     pkgJsonPath?: string;
+    /**
+     * Additional arguments to pass to `jsr publish`.
+     */
     publishArgs?: string[];
+    /**
+     * Allow `--allow-dirty` to be passed to `jsr publish`.
+     * Defaults to `true`, as usually the version is bumped before publishing.
+     * Set to `false` to prevent `--allow-dirty` from being passed.
+     */
     allowDirty?: boolean;
 }
 interface NormalizedPluginConfig {

package/dist/index.d.ts

@@ -2,9 +2,25 @@ import { PublishOptions } from 'jsr';
 import { NextRelease, VerifyConditionsContext, PrepareContext, PublishContext, SuccessContext, FailContext, VerifyReleaseContext } from 'semantic-release';
 
 interface PluginConfig {
+    /**
+     * Working directory given to `jsr publish`.
+     * Defaults to current directory.
+     */
     cwd?: string;
+    /**
+     * Path to package.json.
+     * Defaults to `cwd` + `/package.json` if it exists.
+     */
     pkgJsonPath?: string;
+    /**
+     * Additional arguments to pass to `jsr publish`.
+     */
     publishArgs?: string[];
+    /**
+     * Allow `--allow-dirty` to be passed to `jsr publish`.
+     * Defaults to `true`, as usually the version is bumped before publishing.
+     * Set to `false` to prevent `--allow-dirty` from being passed.
+     */
     allowDirty?: boolean;
 }
 interface NormalizedPluginConfig {

package/package.json

@@ -61,5 +61,5 @@
     "test": "mocha"
   },
   "type": "module",
-  "version": "1.0.0-develop.8"
+  "version": "1.0.0-develop.9"
 }