fix(createGHA): git remote connection errors (#705)

* chore: add smol debug statement

* fix: broken console log yeeeesh

* chore: rename test to not use the word 'only'

* test: rename certain describe blocks, update snapshots

describe blocks weren't being distinguished properly so this fixes that

* fix: catch remote connection errors

* refactor(logger): use opts instead of flag

feedback: #705 (comment)

__tests__/helpers/get-git-mock.ts

@@ -19,6 +19,11 @@ export default function getGitRemoteMock(
     }
     // second call (used to grab default branch)
     if (arr.length === 2 && arr[0] === 'show' && arr[1] === remote) {
+      if (remote === 'bad-remote') {
+        return Promise.reject(
+          new Error(`fatal: unable to access '${remoteUrl}': Could not resolve host: ${remoteUrl}`)
+        ) as unknown as Response<string>;
+      }
       if (!defaultBranch) return Promise.reject(new Error('Bad mock uh oh')) as unknown as Response<string>;
       return Promise.resolve(`* remote origin
   Fetch URL: ${remoteUrl}

__tests__/lib/__snapshots__/createGHA.test.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`#createGHA command inputs changelogs should run GHA creation workflow and generate valid workflow file 1`] = `
+exports[`#createGHA command inputs changelogs (single) should run GHA creation workflow and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
@@ -14,7 +14,7 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs changelogs should run GHA creation workflow and generate valid workflow file 2`] = `
+exports[`#createGHA command inputs changelogs (single) should run GHA creation workflow and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
@@ -37,16 +37,16 @@ jobs:
       - name: Run \`changelogs\` command 🚀
         uses: readmeio/rdme@v7
         with:
-          rdme: changelogs ./changelogs --key=\${{ secrets.README_API_KEY }}
+          rdme: changelogs ./changelogs/rdme.md --key=\${{ secrets.README_API_KEY }}
 "
 `;
 
-exports[`#createGHA command inputs changelogs should run GHA creation workflow and generate valid workflow file 3`] = `
+exports[`#createGHA command inputs changelogs (single) should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
 Almost done! Just a couple more steps:
-1. Push your newly created file (.github/workflows/rdme-changelogs.yml) to GitHub 🚀
+1. Push your newly created file (.github/workflows/rdme-changelogs-with-github-flag.yml) to GitHub 🚀
 2. Create a GitHub secret called README_API_KEY and populate the value with your ReadMe API key (••••••••••••I_KEY) 🔑
 
 🔐 Check out GitHub's docs for more info on creating encrypted secrets (https://docs.github.com/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)
@@ -55,18 +55,18 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs changelogs should run GHA creation workflow and generate valid workflow file 4`] = `
+exports[`#createGHA command inputs changelogs (single) should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
 
 on:
   push:
     branches:
-      # This workflow will run every time you push code to the following branch: \`some-branch\`
+      # This workflow will run every time you push code to the following branch: \`another-branch\`
       # Check out GitHub's docs for more info on configuring this:
       # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
-      - some-branch
+      - another-branch
 
 jobs:
   rdme-changelogs:
@@ -82,12 +82,12 @@ jobs:
 "
 `;
 
-exports[`#createGHA command inputs changelogs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 1`] = `
+exports[`#createGHA command inputs changelogs should run GHA creation workflow and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
 Almost done! Just a couple more steps:
-1. Push your newly created file (.github/workflows/rdme-changelogs-with-github-flag.yml) to GitHub 🚀
+1. Push your newly created file (.github/workflows/rdme-changelogs.yml) to GitHub 🚀
 2. Create a GitHub secret called README_API_KEY and populate the value with your ReadMe API key (••••••••••••I_KEY) 🔑
 
 🔐 Check out GitHub's docs for more info on creating encrypted secrets (https://docs.github.com/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)
@@ -96,18 +96,18 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs changelogs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 2`] = `
+exports[`#createGHA command inputs changelogs should run GHA creation workflow and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
 
 on:
   push:
     branches:
-      # This workflow will run every time you push code to the following branch: \`another-branch\`
+      # This workflow will run every time you push code to the following branch: \`some-branch\`
       # Check out GitHub's docs for more info on configuring this:
       # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
-      - another-branch
+      - some-branch
 
 jobs:
   rdme-changelogs:
@@ -123,7 +123,7 @@ jobs:
 "
 `;
 
-exports[`#createGHA command inputs changelogs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 3`] = `
+exports[`#createGHA command inputs changelogs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
@@ -137,7 +137,7 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs changelogs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 4`] = `
+exports[`#createGHA command inputs changelogs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
@@ -160,11 +160,11 @@ jobs:
       - name: Run \`changelogs\` command 🚀
         uses: readmeio/rdme@v7
         with:
-          rdme: changelogs ./changelogs/rdme.md --key=\${{ secrets.README_API_KEY }}
+          rdme: changelogs ./changelogs --key=\${{ secrets.README_API_KEY }}
 "
 `;
 
-exports[`#createGHA command inputs custompages should run GHA creation workflow and generate valid workflow file 1`] = `
+exports[`#createGHA command inputs custompages (single) should run GHA creation workflow and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
@@ -178,7 +178,7 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs custompages should run GHA creation workflow and generate valid workflow file 2`] = `
+exports[`#createGHA command inputs custompages (single) should run GHA creation workflow and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
@@ -201,16 +201,16 @@ jobs:
       - name: Run \`custompages\` command 🚀
         uses: readmeio/rdme@v7
         with:
-          rdme: custompages ./custompages --key=\${{ secrets.README_API_KEY }}
+          rdme: custompages ./custompages/rdme.md --key=\${{ secrets.README_API_KEY }}
 "
 `;
 
-exports[`#createGHA command inputs custompages should run GHA creation workflow and generate valid workflow file 3`] = `
+exports[`#createGHA command inputs custompages (single) should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
 Almost done! Just a couple more steps:
-1. Push your newly created file (.github/workflows/rdme-custompages.yml) to GitHub 🚀
+1. Push your newly created file (.github/workflows/rdme-custompages-with-github-flag.yml) to GitHub 🚀
 2. Create a GitHub secret called README_API_KEY and populate the value with your ReadMe API key (••••••••••••I_KEY) 🔑
 
 🔐 Check out GitHub's docs for more info on creating encrypted secrets (https://docs.github.com/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)
@@ -219,18 +219,18 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs custompages should run GHA creation workflow and generate valid workflow file 4`] = `
+exports[`#createGHA command inputs custompages (single) should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
 
 on:
   push:
     branches:
-      # This workflow will run every time you push code to the following branch: \`some-branch\`
+      # This workflow will run every time you push code to the following branch: \`another-branch\`
       # Check out GitHub's docs for more info on configuring this:
       # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
-      - some-branch
+      - another-branch
 
 jobs:
   rdme-custompages:
@@ -246,12 +246,12 @@ jobs:
 "
 `;
 
-exports[`#createGHA command inputs custompages should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 1`] = `
+exports[`#createGHA command inputs custompages should run GHA creation workflow and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
 Almost done! Just a couple more steps:
-1. Push your newly created file (.github/workflows/rdme-custompages-with-github-flag.yml) to GitHub 🚀
+1. Push your newly created file (.github/workflows/rdme-custompages.yml) to GitHub 🚀
 2. Create a GitHub secret called README_API_KEY and populate the value with your ReadMe API key (••••••••••••I_KEY) 🔑
 
 🔐 Check out GitHub's docs for more info on creating encrypted secrets (https://docs.github.com/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)
@@ -260,18 +260,18 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs custompages should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 2`] = `
+exports[`#createGHA command inputs custompages should run GHA creation workflow and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
 
 on:
   push:
     branches:
-      # This workflow will run every time you push code to the following branch: \`another-branch\`
+      # This workflow will run every time you push code to the following branch: \`some-branch\`
       # Check out GitHub's docs for more info on configuring this:
       # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
-      - another-branch
+      - some-branch
 
 jobs:
   rdme-custompages:
@@ -287,7 +287,7 @@ jobs:
 "
 `;
 
-exports[`#createGHA command inputs custompages should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 3`] = `
+exports[`#createGHA command inputs custompages should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
@@ -301,7 +301,7 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs custompages should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 4`] = `
+exports[`#createGHA command inputs custompages should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
@@ -324,11 +324,11 @@ jobs:
       - name: Run \`custompages\` command 🚀
         uses: readmeio/rdme@v7
         with:
-          rdme: custompages ./custompages/rdme.md --key=\${{ secrets.README_API_KEY }}
+          rdme: custompages ./custompages --key=\${{ secrets.README_API_KEY }}
 "
 `;
 
-exports[`#createGHA command inputs docs should run GHA creation workflow and generate valid workflow file 1`] = `
+exports[`#createGHA command inputs docs (single) should run GHA creation workflow and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
@@ -342,7 +342,7 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs docs should run GHA creation workflow and generate valid workflow file 2`] = `
+exports[`#createGHA command inputs docs (single) should run GHA creation workflow and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
@@ -365,16 +365,16 @@ jobs:
       - name: Run \`docs\` command 🚀
         uses: readmeio/rdme@v7
         with:
-          rdme: docs --key=\${{ secrets.README_API_KEY }} --version=1.0.0
+          rdme: docs ./docs/rdme.md --key=\${{ secrets.README_API_KEY }} --version=1.0.0
 "
 `;
 
-exports[`#createGHA command inputs docs should run GHA creation workflow and generate valid workflow file 3`] = `
+exports[`#createGHA command inputs docs (single) should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
 Almost done! Just a couple more steps:
-1. Push your newly created file (.github/workflows/rdme-docs.yml) to GitHub 🚀
+1. Push your newly created file (.github/workflows/rdme-docs-with-github-flag.yml) to GitHub 🚀
 2. Create a GitHub secret called README_API_KEY and populate the value with your ReadMe API key (••••••••••••I_KEY) 🔑
 
 🔐 Check out GitHub's docs for more info on creating encrypted secrets (https://docs.github.com/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)
@@ -383,18 +383,18 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs docs should run GHA creation workflow and generate valid workflow file 4`] = `
+exports[`#createGHA command inputs docs (single) should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
 
 on:
   push:
     branches:
-      # This workflow will run every time you push code to the following branch: \`some-branch\`
+      # This workflow will run every time you push code to the following branch: \`another-branch\`
       # Check out GitHub's docs for more info on configuring this:
       # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
-      - some-branch
+      - another-branch
 
 jobs:
   rdme-docs:
@@ -410,12 +410,12 @@ jobs:
 "
 `;
 
-exports[`#createGHA command inputs docs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 1`] = `
+exports[`#createGHA command inputs docs should run GHA creation workflow and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
 Almost done! Just a couple more steps:
-1. Push your newly created file (.github/workflows/rdme-docs-with-github-flag.yml) to GitHub 🚀
+1. Push your newly created file (.github/workflows/rdme-docs.yml) to GitHub 🚀
 2. Create a GitHub secret called README_API_KEY and populate the value with your ReadMe API key (••••••••••••I_KEY) 🔑
 
 🔐 Check out GitHub's docs for more info on creating encrypted secrets (https://docs.github.com/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)
@@ -424,18 +424,18 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs docs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 2`] = `
+exports[`#createGHA command inputs docs should run GHA creation workflow and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
 
 on:
   push:
     branches:
-      # This workflow will run every time you push code to the following branch: \`another-branch\`
+      # This workflow will run every time you push code to the following branch: \`some-branch\`
       # Check out GitHub's docs for more info on configuring this:
       # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
-      - another-branch
+      - some-branch
 
 jobs:
   rdme-docs:
@@ -451,7 +451,7 @@ jobs:
 "
 `;
 
-exports[`#createGHA command inputs docs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 3`] = `
+exports[`#createGHA command inputs docs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 1`] = `
 "
 Your GitHub Actions workflow file has been created! ✨
 
@@ -465,7 +465,7 @@ Almost done! Just a couple more steps:
 "
 `;
 
-exports[`#createGHA command inputs docs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 4`] = `
+exports[`#createGHA command inputs docs should run GHA creation workflow with \`--github\` flag and messy file name and generate valid workflow file 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
@@ -488,7 +488,7 @@ jobs:
       - name: Run \`docs\` command 🚀
         uses: readmeio/rdme@v7
         with:
-          rdme: docs ./docs/rdme.md --key=\${{ secrets.README_API_KEY }} --version=1.0.0
+          rdme: docs --key=\${{ secrets.README_API_KEY }} --version=1.0.0
 "
 `;