feat(GHA): workflow file creation onboarding

.github/workflows/retag-release.yaml

@@ -1,7 +1,7 @@
 # This script adds a "vX.Y.Z" tag to every new release.
 #
 # Our releases are tagged like "1.2.3" but we want people to be able to write
-# GitHub Action workflows to say "uses: readmeio/[email protected]" because that's
+# GitHub Actions workflows to say "uses: readmeio/[email protected]" because that's
 # the usual GitHub convention.
 
 name: retag-release

__tests__/__snapshots__/index.test.ts.snap

@@ -15,10 +15,11 @@ Options
                               uploading an existing API definition.                                 
   --version string            Project version. If running command in a CI environment and this      
                               option is not passed, the main project version will be used.          
-  --create                    Bypasses the create/update prompt and creates a new API definition.   
   --useSpecVersion            Uses the version listed in the \`info.version\` field in the API        
                               definition for the project version parameter.                         
+  --github                    Create a new GitHub Actions workflow for this command.                
   --workingDirectory string   Working directory (for usage with relative external references)       
+  --create                    Bypasses the create/update prompt and creates a new API definition.   
   --update                    Automatically update an existing API definition in ReadMe if it's the 
                               only one associated with the current version.                         
   -h, --help                  Display this usage guide                                              
@@ -45,10 +46,11 @@ Options
                               uploading an existing API definition.                                 
   --version string            Project version. If running command in a CI environment and this      
                               option is not passed, the main project version will be used.          
-  --create                    Bypasses the create/update prompt and creates a new API definition.   
   --useSpecVersion            Uses the version listed in the \`info.version\` field in the API        
                               definition for the project version parameter.                         
+  --github                    Create a new GitHub Actions workflow for this command.                
   --workingDirectory string   Working directory (for usage with relative external references)       
+  --create                    Bypasses the create/update prompt and creates a new API definition.   
   --update                    Automatically update an existing API definition in ReadMe if it's the 
                               only one associated with the current version.                         
   -h, --help                  Display this usage guide                                              
@@ -75,10 +77,11 @@ Options
                               uploading an existing API definition.                                 
   --version string            Project version. If running command in a CI environment and this      
                               option is not passed, the main project version will be used.          
-  --create                    Bypasses the create/update prompt and creates a new API definition.   
   --useSpecVersion            Uses the version listed in the \`info.version\` field in the API        
                               definition for the project version parameter.                         
+  --github                    Create a new GitHub Actions workflow for this command.                
   --workingDirectory string   Working directory (for usage with relative external references)       
+  --create                    Bypasses the create/update prompt and creates a new API definition.   
   --update                    Automatically update an existing API definition in ReadMe if it's the 
                               only one associated with the current version.                         
   -h, --help                  Display this usage guide                                              

__tests__/cmds/__snapshots__/validate.test.ts.snap

@@ -1,5 +1,153 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt (github flag enabled) 1`] = `
+"
+Your GitHub Actions workflow file has been created! ✨
+
+Almost done! Push your newly created file (.github/workflows/validate-test-opt-spec-github-file.yml) to GitHub and you're all set 🚀
+
+🦉 If you have any more questions, feel free to drop us a line! [email protected]
+"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt (github flag enabled) 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: \`validate-test-opt-spec-github-branch\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - validate-test-opt-spec-github-branch
+
+jobs:
+  rdme-validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`validate\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: validate __tests__/__fixtures__/petstore-simple-weird-version.json
+"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt (including workingDirectory) 1`] = `
+"
+Your GitHub Actions workflow file has been created! ✨
+
+Almost done! Push your newly created file (.github/workflows/validate-test-opt-spec-workdir-file.yml) to GitHub and you're all set 🚀
+
+🦉 If you have any more questions, feel free to drop us a line! [email protected]
+"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt (including workingDirectory) 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: \`validate-test-opt-spec-github-branch\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - validate-test-opt-spec-github-branch
+
+jobs:
+  rdme-validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`validate\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: validate petstore.json --workingDirectory=./__tests__/__fixtures__/relative-ref-oas
+"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt 1`] = `
+"
+Your GitHub Actions workflow file has been created! ✨
+
+Almost done! Push your newly created file (.github/workflows/validate-test-opt-spec-file.yml) to GitHub and you're all set 🚀
+
+🦉 If you have any more questions, feel free to drop us a line! [email protected]
+"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt 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: \`validate-test-opt-spec-branch\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - validate-test-opt-spec-branch
+
+jobs:
+  rdme-validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`validate\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: validate __tests__/__fixtures__/petstore-simple-weird-version.json
+"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via prompts 1`] = `
+"
+Your GitHub Actions workflow file has been created! ✨
+
+Almost done! Push your newly created file (.github/workflows/validate-test-file.yml) to GitHub and you're all set 🚀
+
+🦉 If you have any more questions, feel free to drop us a line! [email protected]
+"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via prompts 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: \`validate-test-branch\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - validate-test-branch
+
+jobs:
+  rdme-validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`validate\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: validate __tests__/__fixtures__/petstore-simple-weird-version.json
+"
+`;
+
 exports[`rdme validate error handling should throw an error if an invalid OpenAPI 3.1 definition is supplied 1`] = `
 [SyntaxError: OpenAPI schema validation failed.
 

__tests__/cmds/docs/__snapshots__/index.test.ts.snap

@@ -0,0 +1,124 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`rdme docs GHA onboarding E2E tests should create GHA workflow with version passed as opt (github flag enabled) 1`] = `
+"
+Your GitHub Actions workflow file has been created! ✨
+
+Almost done! Just a couple more steps:
+1. Push your newly created file (.github/workflows/docs-test-file-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)
+
+🦉 If you have any more questions, feel free to drop us a line! [email protected]
+"
+`;
+
+exports[`rdme docs GHA onboarding E2E tests should create GHA workflow with version passed as opt (github flag enabled) 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: \`docs-test-branch-github-flag\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - docs-test-branch-github-flag
+
+jobs:
+  rdme-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`docs\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: docs ./__tests__/__fixtures__/docs/new-docs --key=\${{ secrets.README_API_KEY }} --version=1.0.0
+"
+`;
+
+exports[`rdme docs GHA onboarding E2E tests should create GHA workflow with version passed in via opt 1`] = `
+"
+Your GitHub Actions workflow file has been created! ✨
+
+Almost done! Just a couple more steps:
+1. Push your newly created file (.github/workflows/docs-test-file.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)
+
+🦉 If you have any more questions, feel free to drop us a line! [email protected]
+"
+`;
+
+exports[`rdme docs GHA onboarding E2E tests should create GHA workflow with version passed in via opt 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: \`docs-test-branch\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - docs-test-branch
+
+jobs:
+  rdme-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`docs\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: docs ./__tests__/__fixtures__/docs/new-docs --key=\${{ secrets.README_API_KEY }} --version=1.0.0
+"
+`;
+
+exports[`rdme docs GHA onboarding E2E tests should create GHA workflow with version passed in via prompt 1`] = `
+"
+Your GitHub Actions workflow file has been created! ✨
+
+Almost done! Just a couple more steps:
+1. Push your newly created file (.github/workflows/docs-test-file.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)
+
+🦉 If you have any more questions, feel free to drop us a line! [email protected]
+"
+`;
+
+exports[`rdme docs GHA onboarding E2E tests should create GHA workflow with version passed in via prompt 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: \`docs-test-branch\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - docs-test-branch
+
+jobs:
+  rdme-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`docs\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: docs ./__tests__/__fixtures__/docs/new-docs --key=\${{ secrets.README_API_KEY }} --version=1.0.1
+"
+`;