switch to commitMode

Andarist · Andarist · commit 313b693f7ac8 · 2025-05-02T15:31:09.000+02:00
diff --git a/.changeset/green-dogs-change.md b/.changeset/green-dogs-change.md
@@ -2,9 +2,6 @@
 "@changesets/action": minor
 ---
 
-Introduce a new input commitUsingApi that allows pushing tags and commits
-using the GitHub API instead of the git CLI.
+Introduce a new input `commitMode` that allows using the GitHub API for pushing tags and commits instead of the Git CLI.
 
-When used, this means means that all tags and commits will be attributed
-to the user whose GITHUB_TOKEN is used,
-and also signed using GitHub's internal GPG key.
+When used with `"github-api"` value all tags and commits will be attributed to the user whose GITHUB_TOKEN is used, and also signed using GitHub's internal GPG key.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Changesets Release Action
 
-This action for [Changesets](https://github.com/atlassian/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.
+This action for [Changesets](https://github.com/changesets/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.
 
 ## Usage
 
@@ -12,7 +12,7 @@ This action for [Changesets](https://github.com/atlassian/changesets) creates a
 - title - The pull request title. Default to `Version Packages`
 - setupGitUser - Sets up the git user for commits as `"github-actions[bot]"`. Default to `true`
 - createGithubReleases - A boolean value to indicate whether to create Github releases after `publish` or not. Default to `true`
-- commitUsingApi - A boolean value to indicate whether to use the GitHub API to push changes or not, so changes are GPG-signed. Default to `false`
+- commitMode - Specifies the commit mode. Use `"git-cli"` to push changes using the Git CLI, or `"github-api"` to push changes via the GitHub API. When using `"github-api"`, all commits and tags are GPG-signed and attributed to the user or app who owns the `GITHUB_TOKEN`. Default to `git-cli`.
 - cwd - Changes node's `process.cwd()` if the project is not located on the root. Default to `process.cwd()`
 
 ### Outputs
diff --git a/action.yml b/action.yml
@@ -28,13 +28,14 @@ inputs:
     description: "A boolean value to indicate whether to create Github releases after `publish` or not"
     required: false
     default: true
-  commitUsingApi:
+  commitMode:
     description: >
-      A boolean value to indicate whether to push changes via Github API or not,
-      this will mean all commits and tags are signed using GitHub's GPG key,
-      and attributed to the user or app who owns the GITHUB_TOKEN
+      An enum to specify the commit mode. Use "git-cli" to push changes using the Git CLI,
+      or "github-api" to push changes via the GitHub API. When using "github-api",
+      all commits and tags are signed using GitHub's GPG key and attributed to the user
+      or app who owns the GITHUB_TOKEN.
     required: false
-    default: false
+    default: "git-cli"
   branch:
     description: Sets the branch in which the action will run. Default to `github.ref_name` if not provided
     required: false
diff --git a/src/index.ts b/src/index.ts
@@ -22,8 +22,12 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
   }
 
   const octokit = setupOctokit(githubToken);
-  const commitUsingApi = core.getBooleanInput("commitUsingApi");
-  const git = new Git(commitUsingApi ? octokit : undefined);
+  const commitMode = getOptionalInput("commitMode") ?? "git-cli";
+  if (commitMode !== "git-cli" && commitMode !== "github-api") {
+    core.setFailed(`Invalid commit mode: ${commitMode}`);
+    return;
+  }
+  const git = new Git(commitMode === "github-api" ? octokit : undefined);
 
   let setupGitUser = core.getBooleanInput("setupGitUser");
 
@@ -114,7 +118,7 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
       const octokit = setupOctokit(githubToken);
       const { pullRequestNumber } = await runVersion({
         script: getOptionalInput("version"),
-        git: new Git(commitUsingApi ? octokit : undefined),
+        git,
         octokit,
         prTitle: getOptionalInput("title"),
         commitMessage: getOptionalInput("commit"),
