Install local binary (#5)

* Add detail to README. Remove outputs for local binary. Address linting issues.

.github/workflows/ci.yml

@@ -56,7 +56,6 @@ jobs:
         uses: ./
         with:
           install-cli: yes
-          install-local-binary: yes
 
       - name: Print Output
         id: output

README.md

@@ -1,5 +1,23 @@
 # Install Oso Cloud Tools
 
-Installs the Oso Cloud CLI and Oso Cloud local binary on a GitHub actions runner.
+Installs the
+[Oso Cloud CLI](https://www.osohq.com/docs/reference/client-apis/cli)
+on a GitHub actions runner.
 
-More to come.
+The CLI is required for the following Oso Cloud GitHub actions:
+
+- validate-polar-syntax (a wrapper for `oso-cloud validate`)
+- run-polar-tests (a wrapper for `oso-cloud test`)
+- deploy-polar-code (a wrapper for `oso-cloud policy`)
+
+See the documentation for each action for additional information about that action.
+
+Inputs: none
+Outputs:
+
+- cli-version: The version number of the CLI that was installed
+- cli-sha: The SHA of the CLI that was installed
+
+Currently, the action always installs the latest version of the CLI.
+A future revision will bundle a specific version with each release,
+so that previous versions of the CLI can be deployed if desired.

__tests__/main.test.ts

@@ -45,8 +45,6 @@ describe('action', () => {
       switch (name) {
         case 'install-cli':
           return 'yes'
-        case 'install-local-binary':
-          return 'yes'
         default:
           return ''
       }
@@ -62,10 +60,6 @@ describe('action', () => {
     expect(installCliMock).toHaveBeenCalled()
 
     expect(debugMock).toHaveBeenNthCalledWith(1, 'Installing Oso Cloud CLI')
-    expect(debugMock).toHaveBeenNthCalledWith(
-      2,
-      'Installing Oso Cloud local binary'
-    )
     expect(setOutputMock).toHaveBeenNthCalledWith(1, 'cli-version', '0.12.5')
     expect(setOutputMock).toHaveBeenNthCalledWith(
       2,
@@ -80,8 +74,6 @@ describe('action', () => {
       switch (name) {
         case 'install-cli':
           return 'maybe'
-        case 'install-local-binary':
-          return 'yes'
         default:
           return ''
       }
@@ -98,29 +90,4 @@ describe('action', () => {
     expect(errorMock).not.toHaveBeenCalled()
     expect(setOutputMock).not.toHaveBeenCalledTimes(1)
   })
-
-  it('sets a failed status on an invalid install-local-binary input', async () => {
-    // Set the action's inputs as return values from core.getInput()
-    getInputMock.mockImplementation((name: string): string => {
-      switch (name) {
-        case 'install-cli':
-          return 'yes'
-        case 'install-local-binary':
-          return 'maybe'
-        default:
-          return ''
-      }
-    })
-
-    await main.run()
-    expect(runMock).toHaveReturned()
-
-    // Verify that all of the core library functions were called correctly
-    expect(setFailedMock).toHaveBeenNthCalledWith(
-      1,
-      'Invalid value for install-local-binary: maybe. Please specify either "yes" or "no".'
-    )
-    expect(errorMock).not.toHaveBeenCalled()
-    expect(setOutputMock).not.toHaveBeenCalledTimes(1)
-  })
 })

action.yml

@@ -11,18 +11,12 @@ inputs:
     description: Whether or not to install the OSO Cloud CLI.
     required: false
     default: 'yes'
-  install-local-binary:
-    description: Whether or not to install the OSO Cloud local binary.
-    required: false
-    default: 'yes'
 
 outputs:
   cli-version:
     description: 'The version of the OSO Cloud CLI that was installed'
   cli-sha:
     description: 'The SHA of the OSO Cloud CLI that was installed'
-  local-binary-version:
-    description: 'The version of the OSO Cloud local binary that was installed'
 
 runs:
   using: node20

src/main.ts

@@ -9,21 +9,13 @@ export async function run(): Promise<void> {
   try {
     const validInstallInputValues: Set<string> = new Set(['yes', 'no'])
     const shouldInstallCli: string = core.getInput('install-cli')
-    const shouldInstallLocalBinary: string = core.getInput(
-      'install-local-binary'
-    )
 
     // Validate inputs
     if (!validInstallInputValues.has(shouldInstallCli)) {
       throw new Error(
         `Invalid value for install-cli: ${shouldInstallCli}. Please specify either "yes" or "no".`
       )
     }
-    if (!validInstallInputValues.has(shouldInstallLocalBinary)) {
-      throw new Error(
-        `Invalid value for install-local-binary: ${shouldInstallLocalBinary}. Please specify either "yes" or "no".`
-      )
-    }
 
     if (shouldInstallCli === 'yes') {
       // Debug logs are only output if the `ACTIONS_STEP_DEBUG` secret is true
@@ -33,9 +25,6 @@ export async function run(): Promise<void> {
       core.setOutput('cli-version', cliInfo.split(' ')[1])
       core.setOutput('cli-sha', cliInfo.split(' ')[3])
     }
-    if (shouldInstallLocalBinary === 'yes') {
-      core.debug('Installing Oso Cloud local binary')
-    }
   } catch (error) {
     // Fail the workflow run if an error occurs
     if (error instanceof Error) core.setFailed(error.message)