feat: add directory input to specify a custom working directory

README.md

@@ -13,6 +13,12 @@ Currently this action uses the [newrelic-forks/repolinter](https://github.com/ne
 ```yaml
 - uses: repolinter-action@v1
   with:
+    # The directory Repolinter should run against. Accepts an absolute path
+    # or a path relative to $GITHUB_WORKSPACE.
+    #  
+    # Defaults to $GITHUB_WORKSPACE.
+    directory: ''
+
     # A path to the JSON/YAML Repolinter ruleset to use, relative to the workflow
     # working directory (i.e. under `$GITHUB_WORKSPACE`).
     # 

__tests__/integration.test.ts

@@ -33,6 +33,7 @@ function getInputName(input: string): string {
 
 function getBaseEnv(): NodeJS.ProcessEnv {
   const ret: NodeJS.ProcessEnv = {}
+  ret[getInputName(ActionInputs.DIRECTORY)] = '.'
   ret[getInputName(ActionInputs.REPO)] = 'newrelic/repolinter-action'
   ret[getInputName(ActionInputs.OUTPUT_TYPE)] = 'exit-code'
   ret[getInputName(ActionInputs.OUTPUT_NAME)] = 'Open Source Policy Issues'
@@ -97,4 +98,17 @@ describe('integration', () => {
     expect(out).toContain('passingtestconfig.json')
     expect(out).not.toContain('undefined')
   })
+
+  test('runs a config in a custom directory', async () => {
+    const baseEnv = getBaseEnv()
+    baseEnv[getInputName(ActionInputs.DIRECTORY)] = './__tests__/testfolder'
+    baseEnv[getInputName(ActionInputs.CONFIG_FILE)] =
+      './__tests__/testfolder/nestedtestconfig.json'
+
+    const {out, code} = await runAction(Object.assign({}, process.env, baseEnv))
+
+    expect(code).toEqual(0)
+    expect(out).toContain('nestedtestconfig.json')
+    expect(out).not.toContain('undefined')
+  })
 })

__tests__/main.test.ts

@@ -30,6 +30,7 @@ describe('main', () => {
     // reset process.env
     process.env = {}
     // reset inputs
+    process.env[getInputName(ActionInputs.DIRECTORY)] = '.'
     process.env[getInputName(ActionInputs.REPO)] = 'newrelic/repolinter-action'
     process.env[getInputName(ActionInputs.OUTPUT_TYPE)] = 'exit-code'
     process.env[getInputName(ActionInputs.OUTPUT_NAME)] =
@@ -48,6 +49,18 @@ describe('main', () => {
     })
   })
 
+  test('throws when no directory is supplied', async () => {
+    delete process.env[getInputName(ActionInputs.DIRECTORY)]
+
+    await run()
+    const outputs = getOutputs(spooledStdout)
+
+    // console.debug(out)
+    expect(outputs[ActionOutputs.ERRORED]).toEqual('true')
+    expect(outputs[ActionOutputs.PASSED]).toEqual('false')
+    expect(process.exitCode).not.toEqual(0)
+  })
+
   test('throws when no token is supplied and output-type is not off', async () => {
     process.env[getInputName(ActionInputs.OUTPUT_TYPE)] = 'issue'
 
@@ -288,6 +301,45 @@ describe('main', () => {
     expect(process.exitCode).not.toEqual(0)
   })
 
+  test('runs in a custom directory', async () => {
+    process.env[getInputName(ActionInputs.DIRECTORY)] = './__tests__/testfolder'
+    process.env[getInputName(ActionInputs.CONFIG_FILE)] =
+      './__tests__/testfolder/nestedtestconfig.json'
+
+    await run()
+    const outputs = getOutputs(spooledStdout)
+
+    expect(outputs[ActionOutputs.ERRORED]).toEqual('false')
+    expect(outputs[ActionOutputs.PASSED]).toEqual('true')
+    expect(process.exitCode).toEqual(0)
+  })
+
+  test('throws when given an invalid directory', async () => {
+    process.env[getInputName(ActionInputs.DIRECTORY)] = 'notafolder'
+    process.env[getInputName(ActionInputs.CONFIG_FILE)] =
+      './__tests__/testfolder/nestedtestconfig.json'
+
+    await run()
+    const outputs = getOutputs(spooledStdout)
+
+    expect(outputs[ActionOutputs.ERRORED]).toEqual('true')
+    expect(outputs[ActionOutputs.PASSED]).toEqual('false')
+    expect(process.exitCode).not.toEqual(0)
+  })
+
+  test('throws when given an file instead of a directory', async () => {
+    process.env[getInputName(ActionInputs.DIRECTORY)] = 'action.yml'
+    process.env[getInputName(ActionInputs.CONFIG_FILE)] =
+      './__tests__/testfolder/nestedtestconfig.json'
+
+    await run()
+    const outputs = getOutputs(spooledStdout)
+
+    expect(outputs[ActionOutputs.ERRORED]).toEqual('true')
+    expect(outputs[ActionOutputs.PASSED]).toEqual('false')
+    expect(process.exitCode).not.toEqual(0)
+  })
+
   test('throws if the config is invalid', async () => {
     const configPath = path.resolve(__dirname, 'invalidtestconfig.json')
     process.env[getInputName(ActionInputs.CONFIG_FILE)] = configPath

__tests__/testfolder/nestedtestconfig.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "https://raw.githubusercontent.com/prototypicalpro/repolinter/master/rulesets/schema.json",
+    "version": 2,
+    "axioms": {},
+    "rules": {
+        "readme-file-exists": {
+            "level": "error",
+            "rule": {
+                "type": "file-existence",
+                "options": {
+                    "globsAny": ["README*"],
+                    "nocase": true
+                }
+            }
+        }
+    }
+}

action.yml

@@ -2,6 +2,14 @@ name: 'Repolinter Action'
 description: 'Runs Repolinter against a repository, then uses the results to open an issue.'
 author: 'New Relic Opensource'
 inputs:
+  directory:
+    required: false
+    description: >
+      The directory Repolinter should run against. Accepts an absolute path
+      or a path relative to $GITHUB_WORKSPACE.
+      
+      Defaults to $GITHUB_WORKSPACE.
+    default: ${{ github.workspace }}
   token:
     required: false
     description: >
@@ -29,7 +37,7 @@ inputs:
   config_file:
     required: false
     description: >
-      A path to the JSON or YAML Repolinter ruleset to use, relative to the workflow
+      A path to the JSON or YAML Repolinter ruleset to use, relative to the 
       working directory (i.e. under `$GITHUB_WORKSPACE`). 
       
       This option is mutually exclusive with config_url. If this option and 

src/inputs.ts

@@ -1,4 +1,5 @@
 export const enum ActionInputs {
+  DIRECTORY = 'directory',
   TOKEN = 'token',
   USERNAME = 'username',
   CONFIG_URL = 'config_url',

src/main.ts

@@ -8,11 +8,13 @@ import {
   markdownFormatter,
   jsonFormatter
 } from 'repolinter'
+import * as fs from 'fs'
 import getConfig from './getConfig'
 import createOrUpdateIssue from './createorUpdateIssue'
 
 function getInputs(): {[key: string]: string} {
   return {
+    DIRECTORY: core.getInput(ActionInputs.DIRECTORY, {required: true}),
     TOKEN: core.getInput(ActionInputs.TOKEN),
     USERNAME: core.getInput(ActionInputs.USERNAME, {required: true}),
     CONFIG_URL: core.getInput(ActionInputs.CONFIG_URL),
@@ -30,6 +32,7 @@ export default async function run(disableRetry?: boolean): Promise<void> {
   try {
     // get all inputs
     const {
+      DIRECTORY,
       TOKEN,
       USERNAME,
       CONFIG_FILE,
@@ -40,6 +43,16 @@ export default async function run(disableRetry?: boolean): Promise<void> {
       LABEL_NAME,
       LABEL_COLOR
     } = getInputs()
+    // verify the directory exists and is a directory
+    try {
+      const stat = await fs.promises.stat(DIRECTORY)
+      if (!stat.isDirectory())
+        throw new Error(
+          `Supplied input directory ${DIRECTORY} is not a directory`
+        )
+    } catch (e) {
+      throw e
+    }
     // verify the output type is correct
     if (OUTPUT_TYPE !== 'exit-code' && OUTPUT_TYPE !== 'issue')
       throw new Error(`Invalid output paramter value ${OUTPUT_TYPE}`)
@@ -59,7 +72,7 @@ export default async function run(disableRetry?: boolean): Promise<void> {
       configUrl: CONFIG_URL
     })
     // run the linter!
-    const result = await lint('.', undefined, config, true)
+    const result = await lint(DIRECTORY, undefined, config, true)
     core.debug(JSON.stringify(result))
     // print the formatted result
     core.startGroup('Repolinter Output')