feat: export git user environment variables (#1)

Author: dsanders11

README.md

@@ -50,6 +50,8 @@ jobs:
 - `org` - *(optional)* The organization for an org-scoped token
 - `owner` - *(optional)* The repository owner for a repo-scoped token
 - `repo` - *(optional)* The repository name for a repo-scoped token
+- `export-git-user` - *(optional)* [Export environment variables][git-env-variables]
+  which set the git user to the GitHub app user
 
 ### Outputs
 
@@ -60,3 +62,4 @@ jobs:
 MIT
 
 [generating-cred-bundle]: https://github.com/electron/github-app-auth#generating-credentials
+[git-env-variables]: https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables

__tests__/index.test.ts

@@ -6,9 +6,12 @@ import {
 } from '@electron/github-app-auth'
 
 import * as index from '../src/index'
+import { GitHub } from '@actions/github/lib/utils'
 
 jest.mock('@actions/core', () => {
   return {
+    exportVariable: jest.fn(),
+    getBooleanInput: jest.fn(),
     getInput: jest.fn(),
     getState: jest.fn(),
     info: jest.fn(),
@@ -28,15 +31,35 @@ jest.mock('@actions/github', () => {
     }
   }
 })
+jest.mock('@actions/github/lib/utils')
 jest.mock('@electron/github-app-auth')
 
 jest
   .mocked(appCredentialsFromString)
   .mockReturnValue({ appId: '12345', privateKey: 'private' })
 
+const getAuthenticated = jest.fn()
+const getByUsername = jest.fn()
+
+;(GitHub as unknown as jest.Mock).mockReturnValue({
+  rest: {
+    apps: {
+      getAuthenticated
+    },
+    users: {
+      getByUsername
+    }
+  }
+})
+
 // Spy the action's entrypoint
 const runSpy = jest.spyOn(index, 'run')
 
+const slug = 'my-app'
+const userId = 12345
+const username = `${slug}[bot]`
+const email = `${userId}+${slug}[bot]@users.noreply.github.com`
+
 describe('action', () => {
   beforeEach(() => {
     jest.clearAllMocks()
@@ -166,6 +189,49 @@ describe('action', () => {
     expect(core.saveState).toHaveBeenLastCalledWith('token', token)
   })
 
+  it('can export a git user with repo token', async () => {
+    const token = 'repo-token'
+    jest.mocked(core.getBooleanInput).mockReturnValue(true)
+    jest.mocked(core.getInput).mockImplementation((name: string) => {
+      switch (name) {
+        case 'creds':
+          return 'foobar'
+        case 'owner':
+          return 'electron'
+        case 'repo':
+          return 'fake-repo'
+        default:
+          return ''
+      }
+    })
+    jest.mocked(getTokenForRepo).mockResolvedValue(token)
+    jest.mocked(getAuthenticated).mockResolvedValue({ data: { slug } })
+    jest.mocked(getByUsername).mockResolvedValue({
+      data: {
+        id: userId
+      }
+    })
+
+    await index.run()
+    expect(runSpy).toHaveReturned()
+
+    // Exports git user environment variables
+    expect(core.exportVariable).toHaveBeenCalledTimes(4)
+    expect(core.exportVariable).toHaveBeenCalledWith(
+      'GIT_AUTHOR_NAME',
+      username
+    )
+    expect(core.exportVariable).toHaveBeenCalledWith('GIT_AUTHOR_EMAIL', email)
+    expect(core.exportVariable).toHaveBeenCalledWith(
+      'GIT_COMMITTER_NAME',
+      username
+    )
+    expect(core.exportVariable).toHaveBeenCalledWith(
+      'GIT_COMMITTER_EMAIL',
+      email
+    )
+  })
+
   it('generates an org token', async () => {
     const token = 'org-token'
     jest.mocked(core.getInput).mockImplementation((name: string) => {
@@ -202,6 +268,47 @@ describe('action', () => {
     expect(core.saveState).toHaveBeenLastCalledWith('token', token)
   })
 
+  it('can export a git user with org token', async () => {
+    const token = 'org-token'
+    jest.mocked(core.getBooleanInput).mockReturnValue(true)
+    jest.mocked(core.getInput).mockImplementation((name: string) => {
+      switch (name) {
+        case 'creds':
+          return 'foobar'
+        case 'org':
+          return 'electron'
+        default:
+          return ''
+      }
+    })
+    jest.mocked(getTokenForOrg).mockResolvedValue(token)
+    jest.mocked(getAuthenticated).mockResolvedValue({ data: { slug } })
+    jest.mocked(getByUsername).mockResolvedValue({
+      data: {
+        id: userId
+      }
+    })
+
+    await index.run()
+    expect(runSpy).toHaveReturned()
+
+    // Exports git user environment variables
+    expect(core.exportVariable).toHaveBeenCalledTimes(4)
+    expect(core.exportVariable).toHaveBeenCalledWith(
+      'GIT_AUTHOR_NAME',
+      username
+    )
+    expect(core.exportVariable).toHaveBeenCalledWith('GIT_AUTHOR_EMAIL', email)
+    expect(core.exportVariable).toHaveBeenCalledWith(
+      'GIT_COMMITTER_NAME',
+      username
+    )
+    expect(core.exportVariable).toHaveBeenCalledWith(
+      'GIT_COMMITTER_EMAIL',
+      email
+    )
+  })
+
   it('handles token generate failure', async () => {
     jest.mocked(core.getInput).mockImplementation((name: string) => {
       switch (name) {

action.yml

@@ -15,6 +15,9 @@ inputs:
   repo:
     description: 'The repo name for a repo-scoped token'
     required: false
+  export-git-user:
+    description: 'Export environment variables which set the git user to the GitHub app user'
+    required: false
 
 outputs:
   token:

dist/index.js

@@ -1,7 +1,10 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
+import { GitHub } from '@actions/github/lib/utils'
 import {
   appCredentialsFromString,
+  getAuthOptionsForOrg,
+  getAuthOptionsForRepo,
   getTokenForOrg,
   getTokenForRepo
 } from '@electron/github-app-auth'
@@ -24,6 +27,7 @@ export async function run(): Promise<void> {
     const org = core.getInput('org')
     let owner = core.getInput('owner')
     let repo = core.getInput('repo')
+    const exportGitUser = core.getBooleanInput('export-git-user')
 
     if (org && (owner || repo)) {
       core.setFailed('Invalid inputs')
@@ -54,6 +58,26 @@ export async function run(): Promise<void> {
 
     // Save token to state so the post function can invalidate
     core.saveState('token', token)
+
+    if (exportGitUser) {
+      const authOpts = await (org
+        ? getAuthOptionsForOrg(org, appCreds)
+        : getAuthOptionsForRepo({ owner, name: repo }, appCreds))
+
+      const appOctokit = new GitHub({ ...authOpts })
+
+      const { data: app } = await appOctokit.rest.apps.getAuthenticated()
+      const username = `${app.slug}[bot]`
+      const { data: user } = await appOctokit.rest.users.getByUsername({
+        username
+      })
+      const email = `${user.id}+${app.slug}[bot]@users.noreply.github.com`
+
+      core.exportVariable('GIT_AUTHOR_NAME', username)
+      core.exportVariable('GIT_AUTHOR_EMAIL', email)
+      core.exportVariable('GIT_COMMITTER_NAME', username)
+      core.exportVariable('GIT_COMMITTER_EMAIL', email)
+    }
   } catch (error) {
     // Fail the workflow run if an error occurs
     if (error instanceof Error) core.setFailed(error.message)