Merge branch 'dev' into releases/v2

Author: JamesIves

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -2,23 +2,22 @@
 name: Bug Report
 about: Create a bug report to help us improve the action.
 labels:
-  - bug
+  - triage ⚠️
 ---
 
 <!-- Please check the Q&A before posting an issue: https://github.com/JamesIves/fetch-api-data-action/discussions/categories/q-a -->
 
 ## Describe the bug
-
 <!-- Please provide a clear and concise description of what the bug is. -->
 
 ## Reproduction Steps
-
 <!-- Steps to reproduce the behavior. -->
 
 ## Logs
+<!-- Please provide your deployment logs. If the error message isn't revealing the problem please set ACTIONS_STEP_DEBUG to true in your repository's secrets menu and run the workflow again. -->
 
-<!-- Please provide your deployment logs and a link or sample to/of your workflow. If the error message isn't revealing the problem please set ACTIONS_STEP_DEBUG to true in your repository's secrets menu and run the workflow again. -->
+## Workflow
+<!-- Please provide a link or snippet of your workflow yml file. -->
 
 ## Additional Comments
-
 <!--Add any other context about the problem here. -->

.github/dependabot.yml

@@ -6,3 +6,10 @@ updates:
       interval: daily
       time: '10:00'
     open-pull-requests-limit: 10
+
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: daily
+      time: '10:00'
+    open-pull-requests-limit: 10

.github/workflows/build.yml

@@ -15,9 +15,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2.4.0
 
-      - uses: actions/setup-node@v1.4.4
+      - uses: actions/setup-node@v2.5.1
         with:
           node-version: 'v14.18.1'
           registry-url: 'https://registry.npmjs.org'
@@ -32,6 +32,6 @@ jobs:
           yarn test
 
       - name: Uploade CodeCov Report
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v2.1.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/codeql-analysis.yml

@@ -19,7 +19,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v2.4.0
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v1

.github/workflows/integration.yml

@@ -1,5 +1,11 @@
 name: integration-tests
 on:
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: 'Specifies the branch which the integration tests should run on.'
+        required: true
+        default: 'releases/v2'
   schedule:
     - cron: 25 17 * * 0-6
   push:
@@ -12,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v2
+        uses: actions/checkout@v2.4.0
         with:
           persist-credentials: false
 
@@ -25,7 +31,7 @@ jobs:
           retry: true
 
       - name: Build and Deploy Repo 🚀
-        uses: JamesIves/github-pages-deploy-action@4.1.7
+        uses: JamesIves/github-pages-deploy-action@4.2.0
         with:
           branch: gh-pages
           folder: fetch-api-data-custom

.github/workflows/production.yml

@@ -14,9 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v2.4.0
 
-      - uses: actions/setup-node@v1.4.4
+      - uses: actions/setup-node@v2.5.1
         with:
           node-version: 'v14.18.1'
           registry-url: 'https://registry.npmjs.org'

.github/workflows/publish.yml

@@ -10,14 +10,14 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v2.4.0
         with:
           ref: dev
 
       # Setup .npmrc file to publish to npm
-      - uses: actions/setup-node@v1.4.4
+      - uses: actions/setup-node@v2.5.1
         with:
-          node-version: '10.15.1'
+          node-version: 'v14.18.1'
           registry-url: 'https://registry.npmjs.org'
           scope: '@jamesives'
 
@@ -40,7 +40,7 @@ jobs:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       # Setup .npmrc file to publish to GitHub Packages
-      - uses: actions/setup-node@v1.4.4
+      - uses: actions/setup-node@v2.5.1
         with:
           node-version: 12
           registry-url: 'https://npm.pkg.github.com'

.github/workflows/sponsors.yml

@@ -1,38 +1,26 @@
 name: publish-sponsors
 on:
   workflow_dispatch:
-    inputs:
-      branch:
-        description: 'Specifies the branch which the sponsors should be generated on.'
-        required: true
-        default: 'dev'
   schedule:
     - cron: 30 15 * * 0-6
-  push:
-    tags-ignore:
-      - '*.*'
-    branches:
-      - releases/v1
 
 jobs:
   generate-sponsors:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v2
+        uses: actions/checkout@v2.4.0
 
       - name: Generate Sponsors 💖
-        uses: JamesIves/github-sponsors-readme-action@releases/v1
+        uses: JamesIves/github-sponsors-readme-action@1.0.7
         with:
           token: ${{ secrets.PAT }}
-          marker: 'real-sponsors'
           file: 'README.md'
-          template: '<a href="https://github.com/{{{ login }}}"><img src="https://github.com/{{{ login }}}.png" width="40px" alt="" /></a>'
-          fallback: '<img src="./github/assets/placeholder.png" width="40px" alt="" />'
-          minimum: 1000
+          template: '<a href="https://github.com/{{{ login }}}"><img src="https://github.com/{{{ login }}}.png" width="50px" alt="" /></a>'
+          minimum: 500
 
       - name: Deploy to GitHub Pages
-        uses: JamesIves/github-pages-deploy-action@4.1.1
+        uses: JamesIves/github-pages-deploy-action@4.2.0
         with:
-          branch: ${{ github.event.inputs.branch }}
+          branch: dev
           folder: '.'

README.md

@@ -37,7 +37,7 @@ This <a href="https://github.com/features/actions">GitHub Action</a> will handle
 </p>
 
 <p align="center">
-  This action was originally created for the <a href="https://github.community/t5/Events/Featured-Event-GitHub-Actions-Hackathon/td-p/48206">2020 GitHub Actions Hackathon</a>. You can read about my inspiration for this action <a href="https://jamesiv.es/github/actions/2020/03/07/fetching-authenticated-api-data/">here</a>.
+  This action was originally created for the <a href="https://github.community/t5/Events/Featured-Event-GitHub-Actions-Hackathon/td-p/48206">2020 GitHub Actions Hackathon</a>. You can read about my inspiration for this action <a href="https://jamesiv.es/blog/github/actions/2020/03/07/fetching-authenticated-api-data/">here</a>.
 </p>
 
 <p align="center">
@@ -92,7 +92,7 @@ jobs:
           configuration: '{ "method": "GET", "headers": {"Authorization": "Bearer ${{ secrets.API_TOKEN }}"} }'
 
       - name: Build and Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@4.1.7
+        uses: JamesIves/github-pages-deploy-action@4.2.0
         with:
           branch: main # Pushes the updates to the master branch.
           folder: fetch-api-data-action # The location of the data.json file saved by the Fetch API Data action.
@@ -121,7 +121,7 @@ jobs:
           npm run-script build
 
       - name: Build and Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@4.1.1
+        uses: JamesIves/github-pages-deploy-action@4.2.0
         with:
           branch: gh-pages
           folder: build
@@ -133,7 +133,7 @@ In your project you can import the JSON file and make it part of your build scri
 
 #### Install as a Node Module 📦
 
-If you'd like to use the functionality provided by this action in your own action you can install it using [yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/get-npm) by running the following commands. It's available on both the [npm](https://www.npmjs.com/package/@jamesives/fetch-api-data-action) and [GitHub registry](https://github.com/JamesIves/fetch-api-data-action/packages/229982).
+If you'd like to use the functionality provided by this action in your own action you can either [create a composite action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action), or you can install it using [yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/get-npm) by running the following commands. It's available on both the [npm](https://www.npmjs.com/package/@jamesives/fetch-api-data-action) and [GitHub registry](https://github.com/JamesIves/fetch-api-data-action/packages/229982).
 
 ```
 yarn add @jamesives/fetch-api-data-action

action.yml

@@ -36,6 +36,10 @@ inputs:
     description: 'You can override the name of the exported `.json` file by specifying a new one here. You should _not_ include the file extension in your name.'
     required: false
 
+  debug:
+    description: 'If set to true the action will log the API responses it receives in the terminal.'
+    required: false
+
 outputs:
   fetch-api-data:
     description: 'The requested data from the API stored as a string.'

package.json

@@ -2,7 +2,7 @@
   "name": "@jamesives/fetch-api-data-action",
   "description": "GitHub action for handling authenticated API requests, allowing you to save the data from the request into your workspace as an environment variable and a .json file.",
   "author": "James Ives <iam@jamesiv.es> (https://jamesiv.es)",
-  "version": "1.0.19",
+  "version": "2.0.0",
   "license": "MIT",
   "main": "lib/lib.js",
   "types": "lib/lib.d.ts",
@@ -41,17 +41,17 @@
   },
   "devDependencies": {
     "@types/async-retry": "1.4.3",
-    "@types/jest": "27.0.3",
+    "@types/jest": "27.4.0",
     "@types/mustache": "4.1.2",
-    "@types/node": "17.0.0",
-    "@typescript-eslint/eslint-plugin": "5.7.0",
-    "@typescript-eslint/parser": "5.7.0",
-    "eslint": "8.5.0",
+    "@types/node": "17.0.8",
+    "@typescript-eslint/eslint-plugin": "5.9.0",
+    "@typescript-eslint/parser": "5.9.0",
+    "eslint": "8.6.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-jest": "25.3.0",
+    "eslint-plugin-jest": "25.3.4",
     "eslint-plugin-prettier": "4.0.0",
-    "jest": "27.4.5",
-    "jest-circus": "27.4.5",
+    "jest": "27.4.7",
+    "jest-circus": "27.4.6",
     "nock": "13.2.1",
     "prettier": "2.5.1",
     "ts-jest": "27.1.2",