feat: add release-it-args option

README.md

@@ -69,6 +69,7 @@ permissions:
 | `github-token`            | `string`  | `${GITHUB_TOKEN}`                             | GitHub token (PAT) with _repo_ and _workflow_ permissions.                              |
 | `npm-token`               | `string`  | `${NPM_TOKEN}`                                | npm access token with the _automation_ role.                                            |
 | `skip-branch-protections` | `boolean` | `false`                                       | Whether to skip deleting and recreating branch protections.                             |
+| `release-it-args`         | `string`  | `""`                                          | Any arbitrary arguments to pass to `npx release-it --verbose`.                          |
 
 ### Node API
 
@@ -88,6 +89,7 @@ await releaseItAction({
 	gitUserName: "YourUsername",
 	npmToken: process.env.NPM_TOKEN,
 	owner: "YourUsername",
+	releaseItArgs: "--preRelease=beta",
 	repo: "your-repository",
 });
 ```

src/action/runReleaseItAction.ts

@@ -16,6 +16,7 @@ export async function runReleaseItAction(context: typeof github.context) {
 		gitUserName,
 		npmToken: getTokenInput("npm-token", "NPM_TOKEN"),
 		owner: context.repo.owner,
+		releaseItArgs: core.getInput("release-it-args"),
 		repo: context.repo.repo,
 		skipBranchProtections: core.getBooleanInput("skip-branch-protections"),
 	});

src/index.ts

@@ -15,6 +15,7 @@ export interface ReleaseItActionOptions {
 	gitUserName: string;
 	npmToken: string;
 	owner: string;
+	releaseItArgs?: string;
 	repo: string;
 	skipBranchProtections?: boolean;
 }
@@ -26,6 +27,7 @@ export async function releaseItAction({
 	gitUserName,
 	npmToken,
 	owner,
+	releaseItArgs,
 	repo,
 	skipBranchProtections,
 }: ReleaseItActionOptions) {
@@ -66,7 +68,7 @@ export async function releaseItAction({
 		requestData: commonRequestData,
 	});
 
-	await runReleaseIt();
+	await runReleaseIt(releaseItArgs);
 
 	await recreateProtections({
 		commonRequestData,

src/steps/runReleaseIt.test.ts

@@ -100,4 +100,27 @@ describe("runReleaseIt", () => {
 		expect(mockError).not.toHaveBeenCalled();
 		expect(mockSetFailed).not.toHaveBeenCalled();
 	});
+
+	it("does not releaseItArgs when provided as an empty string", async () => {
+		mock$$.mockResolvedValue({ exitCode: 0 });
+
+		await runReleaseIt("");
+
+		expect(mock$$).toHaveBeenCalledWith(["npx release-it --verbose", ""], "");
+		expect(mockError).not.toHaveBeenCalled();
+		expect(mockSetFailed).not.toHaveBeenCalled();
+	});
+
+	it("includes releaseItArgs when provided as a non-empty string", async () => {
+		mock$$.mockResolvedValue({ exitCode: 0 });
+
+		await runReleaseIt("major --preRelease=beta");
+
+		expect(mock$$).toHaveBeenCalledWith(
+			["npx release-it --verbose", ""],
+			" major --preRelease=beta",
+		);
+		expect(mockError).not.toHaveBeenCalled();
+		expect(mockSetFailed).not.toHaveBeenCalled();
+	});
 });

src/steps/runReleaseIt.ts

@@ -3,10 +3,12 @@ import * as core from "@actions/core";
 import { $$ } from "../execa.js";
 import { tryCatchInfoAction } from "../tryCatchInfoAction.js";
 
-export async function runReleaseIt() {
+export async function runReleaseIt(releaseItArgs?: string) {
+	const args = releaseItArgs ? ` ${releaseItArgs}` : "";
+
 	await tryCatchInfoAction("running release-it", async () => {
 		try {
-			const { exitCode, stderr } = await $$`npx release-it --verbose`;
+			const { exitCode, stderr } = await $$`npx release-it --verbose${args}`;
 			if (exitCode || stderr) {
 				throw new Error(stderr || `Exit code ${exitCode.toString()}.`);
 			}