feat: add commit-author for customization (#53)

* feat: add commit-author and commit-body inputs to action

* feat: implement commit-body and commit-author input parsing with validation

* test: add tests for commit-body and commit-author features

* docs: document commit-author and commit-body inputs

* refactor: remove commit-body input in favor of multi-line message

---------

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>

Author: srivatsan0611

README.md

@@ -61,8 +61,26 @@ jobs:
           token: ${{ steps.generate-token.outputs.token }}
 ```
 
+#### With multi-line message and custom author
+
+```yaml
+- name: Commit with details
+  uses: dsanders11/github-app-commit-action@v1
+  with:
+    message: |
+      feat: add new feature
+
+      This change adds support for the new API.
+
+      Closes #123
+    commit-author: 'Bot User <bot@example.com>'
+    token: ${{ steps.generate-token.outputs.token }}
+```
+
 ### Inputs
 
+- `commit-author` - _(optional)_ Commit author in format "Name &lt;email&gt;".
+  If not provided, the commit will be authored by the GitHub App.
 - `fail-on-no-changes` - _(optional)_ Whether or not to set action failure if
   there are no changes to commit (default: `true`)
 - `force` - _(optional)_ Whether to force the update or to make sure the update

__tests__/main.test.ts

@@ -342,6 +342,120 @@ describe('action', () => {
     expect(core.setOutput).toHaveBeenCalledWith('sha', commitSha);
   });
 
+  it('uses multi-line message for commit', async () => {
+    const multiLineMessage =
+      'feat: add new feature\n\nThis is the body\nwith multiple lines';
+    const commitSha = 'commit-sha';
+
+    mockGetInput({ message: multiLineMessage, token });
+    mockGetBooleanInput({});
+    vi.mocked(lib.getHeadRef).mockResolvedValue('main');
+    vi.mocked(lib.getHeadSha).mockResolvedValue('head-sha');
+    vi.mocked(lib.getHeadTreeHash).mockResolvedValue('head-tree-hash');
+    vi.mocked(lib.getStagedFiles).mockResolvedValue(stagedFiles);
+    vi.mocked(createTree).mockResolvedValue({ data: { sha: 'tree-sha' } });
+    vi.mocked(createCommit).mockResolvedValue({ data: { sha: commitSha } });
+    vi.mocked(updateRef).mockResolvedValue({ data: {} });
+
+    await main.run();
+    expect(runSpy).toHaveReturned();
+
+    expect(createCommit).toHaveBeenCalledWith(
+      expect.objectContaining({
+        message: multiLineMessage
+      })
+    );
+
+    expect(core.setOutput).toHaveBeenCalledWith('message', multiLineMessage);
+  });
+
+  it('uses commit-author with valid format', async () => {
+    const commitAuthor = 'John Doe <john@example.com>';
+    const commitSha = 'commit-sha';
+
+    mockGetInput({ message, token, 'commit-author': commitAuthor });
+    mockGetBooleanInput({});
+    vi.mocked(lib.getHeadRef).mockResolvedValue('main');
+    vi.mocked(lib.getHeadSha).mockResolvedValue('head-sha');
+    vi.mocked(lib.getHeadTreeHash).mockResolvedValue('head-tree-hash');
+    vi.mocked(lib.getStagedFiles).mockResolvedValue(stagedFiles);
+    vi.mocked(createTree).mockResolvedValue({ data: { sha: 'tree-sha' } });
+    vi.mocked(createCommit).mockResolvedValue({ data: { sha: commitSha } });
+    vi.mocked(updateRef).mockResolvedValue({ data: {} });
+
+    await main.run();
+    expect(runSpy).toHaveReturned();
+
+    expect(createCommit).toHaveBeenCalledWith(
+      expect.objectContaining({
+        author: {
+          name: 'John Doe',
+          email: 'john@example.com'
+        }
+      })
+    );
+  });
+
+  it('warns and ignores invalid commit-author format', async () => {
+    const commitAuthor = 'invalid-format';
+    const commitSha = 'commit-sha';
+
+    mockGetInput({ message, token, 'commit-author': commitAuthor });
+    mockGetBooleanInput({});
+    vi.mocked(lib.getHeadRef).mockResolvedValue('main');
+    vi.mocked(lib.getHeadSha).mockResolvedValue('head-sha');
+    vi.mocked(lib.getHeadTreeHash).mockResolvedValue('head-tree-hash');
+    vi.mocked(lib.getStagedFiles).mockResolvedValue(stagedFiles);
+    vi.mocked(createTree).mockResolvedValue({ data: { sha: 'tree-sha' } });
+    vi.mocked(createCommit).mockResolvedValue({ data: { sha: commitSha } });
+    vi.mocked(updateRef).mockResolvedValue({ data: {} });
+
+    await main.run();
+    expect(runSpy).toHaveReturned();
+
+    expect(core.warning).toHaveBeenCalledWith(
+      'Invalid commit-author format: "invalid-format". Expected format: "Name <email>". Ignoring author.'
+    );
+    expect(createCommit).toHaveBeenCalledWith(
+      expect.not.objectContaining({
+        author: expect.anything()
+      })
+    );
+  });
+
+  it('uses multi-line message with commit-author', async () => {
+    const multiLineMessage = 'feat: add feature\n\nBody text here';
+    const commitAuthor = 'Jane Smith <jane@example.com>';
+    const commitSha = 'commit-sha';
+
+    mockGetInput({
+      message: multiLineMessage,
+      token,
+      'commit-author': commitAuthor
+    });
+    mockGetBooleanInput({});
+    vi.mocked(lib.getHeadRef).mockResolvedValue('main');
+    vi.mocked(lib.getHeadSha).mockResolvedValue('head-sha');
+    vi.mocked(lib.getHeadTreeHash).mockResolvedValue('head-tree-hash');
+    vi.mocked(lib.getStagedFiles).mockResolvedValue(stagedFiles);
+    vi.mocked(createTree).mockResolvedValue({ data: { sha: 'tree-sha' } });
+    vi.mocked(createCommit).mockResolvedValue({ data: { sha: commitSha } });
+    vi.mocked(updateRef).mockResolvedValue({ data: {} });
+
+    await main.run();
+    expect(runSpy).toHaveReturned();
+
+    expect(createCommit).toHaveBeenCalledWith(
+      expect.objectContaining({
+        message: multiLineMessage,
+        author: {
+          name: 'Jane Smith',
+          email: 'jane@example.com'
+        }
+      })
+    );
+  });
+
   it('handles generic errors', async () => {
     mockGetInput({ message, token });
     vi.mocked(lib.getStagedFiles).mockImplementation(() => {

action.yml

@@ -15,6 +15,9 @@ inputs:
     description: Whether to force the update or to make sure the update is a fast-forward update when updating an existing ref
     required: false
     default: false
+  commit-author:
+    description: 'Optional commit author in format "Name <email>"'
+    required: false
   message:
     description: The commit message
     required: true

dist/index.js

@@ -80,6 +80,7 @@ export async function run(): Promise<void> {
     const owner = core.getInput('owner') || github.context.repo.owner;
     const repo = core.getInput('repository') || github.context.repo.repo;
     const workingDirectory = core.getInput('working-directory');
+    const commitAuthor = core.getInput('commit-author');
 
     if (workingDirectory) {
       process.chdir(workingDirectory);
@@ -122,12 +123,29 @@ export async function run(): Promise<void> {
     });
     core.debug(`New tree SHA: ${newTree.data.sha}`);
 
+    // Parse optional commit author
+    let author: { name: string; email: string } | undefined;
+    if (commitAuthor) {
+      const authorMatch = commitAuthor.match(/^(.+?)\s*<(.+?)>$/);
+      if (authorMatch) {
+        author = {
+          name: authorMatch[1].trim(),
+          email: authorMatch[2].trim()
+        };
+      } else {
+        core.warning(
+          `Invalid commit-author format: "${commitAuthor}". Expected format: "Name <email>". Ignoring author.`
+        );
+      }
+    }
+
     const newCommit = await octokit.rest.git.createCommit({
       owner,
       repo,
       parents: [await getHeadSha()],
       message,
-      tree: newTree.data.sha
+      tree: newTree.data.sha,
+      ...(author && { author })
     });
     core.debug(`New commit SHA: ${newCommit.data.sha}`);