feat: Detect shallow copies

Closes Detect shallow working copies & show useful error message #109.

Author: franky47

README.md

@@ -17,8 +17,9 @@ In your workflow file:
 steps:
   # This action requires an unshallow working copy,
   # so the following prerequisites are necessary:
-  - uses: actions/[email protected]
-  - run: git fetch --prune --unshallow
+  - uses: actions/checkout@v3
+    with:
+      fetch-depth: 0
 
   # Deploy your application
   - uses: 47ng/[email protected]

__tests__/main.test.ts

@@ -19,14 +19,14 @@ test('deploy default application (no arguments)', async () => {
     cleverCLI: 'clever'
   })
 
-  expect(exec).toHaveBeenNthCalledWith(1, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
     'login',
     '--token',
     'token',
     '--secret',
     'secret'
   ])
-  expect(exec).toHaveBeenNthCalledWith(2, 'clever', ['deploy'])
+  expect(exec).toHaveBeenNthCalledWith(3, 'clever', ['deploy'])
   expect(core.setFailed).not.toHaveBeenCalled()
 })
 
@@ -38,14 +38,14 @@ test('deploy application with alias', async () => {
     cleverCLI: 'clever'
   })
 
-  expect(exec).toHaveBeenNthCalledWith(1, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
     'login',
     '--token',
     'token',
     '--secret',
     'secret'
   ])
-  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
     'deploy',
     '--alias',
     'app-alias'
@@ -60,20 +60,20 @@ test('deploy application with app ID', async () => {
     appID: 'app_facade42-cafe-babe-cafe-deadf00dbaad',
     cleverCLI: 'clever'
   })
-  expect(exec).toHaveBeenNthCalledWith(1, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
     'login',
     '--token',
     'token',
     '--secret',
     'secret'
   ])
-  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
     'link',
     'app_facade42-cafe-babe-cafe-deadf00dbaad',
     '--alias',
     'app_facade42-cafe-babe-cafe-deadf00dbaad'
   ])
-  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(4, 'clever', [
     'deploy',
     '--alias',
     'app_facade42-cafe-babe-cafe-deadf00dbaad'
@@ -88,20 +88,20 @@ test('when both app ID and alias are provided, appID takes precedence', async ()
     appID: 'app_facade42-cafe-babe-cafe-deadf00dbaad',
     cleverCLI: 'clever'
   })
-  expect(exec).toHaveBeenNthCalledWith(1, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
     'login',
     '--token',
     'token',
     '--secret',
     'secret'
   ])
-  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
     'link',
     'app_facade42-cafe-babe-cafe-deadf00dbaad',
     '--alias',
     'app_facade42-cafe-babe-cafe-deadf00dbaad'
   ])
-  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(4, 'clever', [
     'deploy',
     '--alias',
     'app_facade42-cafe-babe-cafe-deadf00dbaad'
@@ -118,26 +118,26 @@ test('passing extra env variables, using no input args', async () => {
       egg: 'spam'
     }
   })
-  expect(exec).toHaveBeenNthCalledWith(1, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
     'login',
     '--token',
     'token',
     '--secret',
     'secret'
   ])
-  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
     'env',
     'set',
     'foo',
     'bar'
   ])
-  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(4, 'clever', [
     'env',
     'set',
     'egg',
     'spam'
   ])
-  expect(exec).toHaveBeenNthCalledWith(4, 'clever', ['deploy'])
+  expect(exec).toHaveBeenNthCalledWith(5, 'clever', ['deploy'])
 })
 
 test('passing extra env variables, using appID', async () => {
@@ -151,36 +151,36 @@ test('passing extra env variables, using appID', async () => {
       egg: 'spam'
     }
   })
-  expect(exec).toHaveBeenNthCalledWith(1, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
     'login',
     '--token',
     'token',
     '--secret',
     'secret'
   ])
-  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
     'link',
     'app_facade42-cafe-babe-cafe-deadf00dbaad',
     '--alias',
     'app_facade42-cafe-babe-cafe-deadf00dbaad'
   ])
-  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(4, 'clever', [
     'env',
     'set',
     '--alias',
     'app_facade42-cafe-babe-cafe-deadf00dbaad',
     'foo',
     'bar'
   ])
-  expect(exec).toHaveBeenNthCalledWith(4, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(5, 'clever', [
     'env',
     'set',
     '--alias',
     'app_facade42-cafe-babe-cafe-deadf00dbaad',
     'egg',
     'spam'
   ])
-  expect(exec).toHaveBeenNthCalledWith(5, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(6, 'clever', [
     'deploy',
     '--alias',
     'app_facade42-cafe-babe-cafe-deadf00dbaad'
@@ -198,30 +198,30 @@ test('passing extra env variables, using alias only', async () => {
       egg: 'spam'
     }
   })
-  expect(exec).toHaveBeenNthCalledWith(1, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
     'login',
     '--token',
     'token',
     '--secret',
     'secret'
   ])
-  expect(exec).toHaveBeenNthCalledWith(2, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
     'env',
     'set',
     '--alias',
     'foo',
     'foo',
     'bar'
   ])
-  expect(exec).toHaveBeenNthCalledWith(3, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(4, 'clever', [
     'env',
     'set',
     '--alias',
     'foo',
     'egg',
     'spam'
   ])
-  expect(exec).toHaveBeenNthCalledWith(4, 'clever', [
+  expect(exec).toHaveBeenNthCalledWith(5, 'clever', [
     'deploy',
     '--alias',
     'foo'

src/action.ts

@@ -73,6 +73,23 @@ export function processArguments(): Arguments {
   }
 }
 
+async function checkForShallowCopy(): Promise<void> {
+  let output = ''
+  await exec('git', ['rev-parse', '--is-shallow-repository'], {
+    listeners: {
+      stdout: (data: Buffer) => (output += data.toString())
+    }
+  })
+  if (output.trim() === 'true') {
+    throw new Error(`This action requires an unshallow working copy.
+-> Use the following step before running this action:
+ - uses: actions/checkout@v3
+   with:
+     fetch-depth: 0
+`)
+  }
+}
+
 export default async function run({
   token,
   secret,
@@ -83,6 +100,8 @@ export default async function run({
   extraEnv = {}
 }: Arguments): Promise<void> {
   try {
+    await checkForShallowCopy()
+
     core.debug(`Clever CLI path: ${cleverCLI}`)
 
     // Authenticate (this will only store the credentials at a known location)