GitHub enterprise support

README.md

@@ -16,12 +16,13 @@ All processing is done within Github Actions, no data is sent to an external ser
 
 ## Inputs
 
-| Key                  | Required | Default | Description                                                                                           |
-| -------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- |
-| `GITHUB_TOKEN`       | **yes**  | -       | Github Token generated by Github Action workflow. You can pass this in as `${{secrets.GITHUB_TOKEN}}` |
-| `COVERAGE_FILE_PATH` | **yes**  | -       | Location of coverage file that was generated                                                          |
-| `COVERAGE_FORMAT`    | **no**   | lcov    | Format of coverage file. May be `lcov`, `clover`, or `go`                                             |
-| `DEBUG`              | **no**   | -       | Log debugging information. Comma-separated list of possible values `coverage`, `pr_lines_added`       |
+| Key                  | Required | Default                  | Description                                                                                           |
+| -------------------- | -------- | ------------------------ | ----------------------------------------------------------------------------------------------------- |
+| `GITHUB_TOKEN`       | **yes**  | -                        | Github Token generated by Github Action workflow. You can pass this in as `${{secrets.GITHUB_TOKEN}}` |
+| `GITHUB_BASE_URL`    | **no**   | `https://api.github.com` | Base URL for GitHub API. Required for GitHub Enterprise Server or Cloud.                              |
+| `COVERAGE_FILE_PATH` | **yes**  | -                        | Location of coverage file that was generated                                                          |
+| `COVERAGE_FORMAT`    | **no**   | `lcov`                   | Format of coverage file. May be `lcov`, `clover`, or `go`                                             |
+| `DEBUG`              | **no**   | -                        | Log debugging information. Comma-separated list of possible values `coverage`, `pr_lines_added`       |
 
 ## Usage
 
@@ -37,6 +38,21 @@ coverage format with values appropriate for your repo:
     COVERAGE_FORMAT: "lcov"
 ```
 
+## Usage with GitHub Enterprise Server or Cloud
+
+You need to the `GITHUB_BASE_URL` input to point to your API endpoint to use this action with GitHub Enterprise Server or Cloud. For example:
+
+```yaml
+with:
+  GITHUB_BASE_URL: https://github.acme-inc.com/api/v3 # for GitHub Enterprise Server
+```
+ or 
+
+```yaml
+with:
+  GITHUB_BASE_URL: https://api.acme-inc.ghe.com # for GitHub Enterprise Cloud
+```
+
 ### Golang Workflow Example
 
 ```yaml

__tests__/utils/github.test.ts

@@ -2,16 +2,18 @@ import {test} from '@jest/globals'
 import {GithubUtil} from '../../src/utils/github'
 
 test('github init successfully', async function () {
-  const githubUtil = new GithubUtil('1234')
+  const githubUtil = new GithubUtil('1234', 'https://api.github.com')
   expect(githubUtil).toBeInstanceOf(GithubUtil)
 })
 
 test('github init to throw error', function () {
-  expect(() => new GithubUtil('')).toThrowError('GITHUB_TOKEN is missing')
+  expect(() => new GithubUtil('', 'https://api.github.com')).toThrowError(
+    'GITHUB_TOKEN is missing'
+  )
 })
 
 test('build annotations', function () {
-  const githubUtil = new GithubUtil('1234')
+  const githubUtil = new GithubUtil('1234', 'https://api.github.com')
 
   const prFiles = {
     'file1.txt': [

action.yml

@@ -8,6 +8,10 @@ inputs:
   GITHUB_TOKEN:
     required: true
     description: 'Github token from workflow. This is automatically generated by github and is rotated. You can limit scopes of this token as well.'
+  GITHUB_BASE_URL:
+    required: false
+    description: 'Github base URL. Set this if you are using a GitHub Enterprise Server or a instance on `ghe.com``.'
+    default: 'https://api.github.com'
   COVERAGE_FILE_PATH:
     required: true
     description: 'Path to coverage file'

src/action.ts

@@ -18,6 +18,7 @@ export async function play(): Promise<void> {
     }
     core.info('Performing Code Coverage Analysis')
     const GITHUB_TOKEN = core.getInput('GITHUB_TOKEN', {required: true})
+    const GITHUB_BASE_URL = core.getInput('GITHUB_BASE_URL')
     const COVERAGE_FILE_PATH = core.getInput('COVERAGE_FILE_PATH', {
       required: true
     })
@@ -81,7 +82,7 @@ export async function play(): Promise<void> {
         core.info(JSON.stringify(item))
       }
     }
-    const githubUtil = new GithubUtil(GITHUB_TOKEN)
+    const githubUtil = new GithubUtil(GITHUB_TOKEN, GITHUB_BASE_URL)
 
     // 3. Get current pull request files
     const pullRequestFiles = await githubUtil.getPullRequestDiff()

src/utils/github.ts

@@ -12,11 +12,11 @@ import {Octokit} from 'octokit'
 export class GithubUtil {
   private client: Octokit
 
-  constructor(token: string) {
+  constructor(token: string, baseUrl: string) {
     if (!token) {
       throw new Error('GITHUB_TOKEN is missing')
     }
-    this.client = new Octokit({auth: token})
+    this.client = new Octokit({auth: token, baseUrl})
   }
 
   getPullRequestRef(): string {