Merge branch 'dev' into releases/v2

Author: JamesIves

.github/workflows/integration.yml

@@ -46,7 +46,7 @@ jobs:
           folder: fetch-api-data-custom
           target-folder: data
           ssh-key: ${{ secrets.DEPLOY_KEY }}
-        
+
   refresh-api-data-modified-formatting-encoding:
     runs-on: ubuntu-latest
     needs: refresh-api-data
@@ -86,7 +86,6 @@ jobs:
         run: |
           echo "Output: ${{ steps.validate.outputs.fetchApiData }}"
 
-
       - name: Build and Deploy Repo 🚀
         uses: JamesIves/github-pages-deploy-action@v4
         with:

README.md

@@ -190,8 +190,9 @@ The following configuration options should be set.
 | `token-configuration` | Any applicable configuration settings that should be set such as authentication tokens. You can reference secrets using the `${{ secrets.secret_name }}` syntax. For more information refer to the [Fetch API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch).                                                                                                                                                          | `secrets / with` | **No**   |
 | `retry`               | If you're working with an intermittent API you can toggle this option to `true`. Doing so will make the action try the request 3 times at random intervals before failing.                                                                                                                                                                                                                                                                                     | `with`           | **No**   |
 | `save-location`       | By default the save location of the file is `fetch-api-data-action/data.json`, if you'd like to override the directory you can do so by specifying a new one with this variable.                                                                                                                                                                                                                                                                               | `with`           | **No**   |
-| `save-name`           | 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.                                                                                                                                                                                                                                                                                                                 | `with`           | **No**   |
-| `set-output`          | Determines if the returned data should be saved as an environment variable or not. This field defaults to `true`, but depending on your API response length you may need to toggle this. If `true`, an environment variable named `fetchApiData` will be created.                                                                                                                                                                                              | `with`           | **No**   |
+| `save-name`           | 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.                                                                                                                                                                                                                                                                                                                 |
+| `variable-name`       | Adjusts the name of the environment variable the action generates so long as `set-output` is `true`. Defaults to `fetchApiData`.                                                                                                                                                                                                                                                                                                                               | `with`           | **No**   |
+| `set-output`          | Determines if the returned data should be saved as an environment variable or not. This field defaults to `true`, but depending on your API response length you may need to toggle this. If `true`, an environment variable and action step output named `fetchApiData` will be created.                                                                                                                                                                       | `with`           | **No**   |
 | `format`              | Allows you to modify the extension of the file saved from the API response, for example you can set this field to `json` or `txt`. This field defaults to `json`.                                                                                                                                                                                                                                                                                              | `with`           | **No**   |
 | `encoding`            | Allows you to modify the encoding of the file saved from the API response, for example you can set this field to `utf8` or `hex`. This field defaults to `utf8`. Choose from `ascii`, `utf8`, `utf-8`, `utf16le`, `ucs2`, `ucs-2`, `base64`, `latin1`, `binary` or `hex`.                                                                                                                                                                                      | `with`           | **No**   |
 | `debug`               | If set to `true` the action will log the API responses it receives in the terminal.                                                                                                                                                                                                                                                                                                                                                                            | `with`           | **No**   |

__tests__/fetch.test.ts

@@ -1,7 +1,7 @@
 import {retrieveData, generateExport} from '../src/fetch'
 import nock from 'nock'
 
-jest.setTimeout(60000)
+jest.setTimeout(1000000)
 
 describe('fetch', () => {
   describe('retrieveData', () => {
@@ -113,7 +113,7 @@ describe('fetch', () => {
         data: '{"bestCat":"montezuma"}',
         setOutput: true
       })
-      expect(process.env['fetch-api-data']).toBe('{"bestCat":"montezuma"}')
+      expect(process.env['fetchApiData']).toBe('{"bestCat":"montezuma"}')
     })
 
     it('should save non standard file types', async () => {
@@ -124,7 +124,7 @@ describe('fetch', () => {
         saveName: 'montezuma',
         setOutput: true
       })
-      expect(process.env['fetch-api-data']).toBe('hello')
+      expect(process.env['fetchApiData']).toBe('hello')
     })
 
     it('should save the file with customized file location/names', async () => {
@@ -134,7 +134,7 @@ describe('fetch', () => {
         saveName: 'montezuma',
         setOutput: true
       })
-      expect(process.env['fetch-api-data']).toBe('{"bestCat":"montezuma"}')
+      expect(process.env['fetchApiData']).toBe('{"bestCat":"montezuma"}')
     })
 
     it('should save file with custom encoding', async () => {
@@ -145,7 +145,7 @@ describe('fetch', () => {
         saveName: 'hex-data',
         setOutput: true
       })
-      expect(process.env['fetch-api-data']).toBe('68656C6C6F21')
+      expect(process.env['fetchApiData']).toBe('68656C6C6F21')
     })
 
     it('should fail if invalid encoding is used', async () => {

package.json

@@ -35,7 +35,7 @@
     "github-action"
   ],
   "dependencies": {
-    "@actions/core": "1.9.1",
+    "@actions/core": "1.10.0",
     "@actions/io": "1.1.2",
     "async-retry": "1.3.3",
     "cross-fetch": "3.1.5",
@@ -44,18 +44,18 @@
   "devDependencies": {
     "@types/async-retry": "1.4.3",
     "@types/jest": "27.5.0",
-    "@types/mustache": "4.2.1",
-    "@types/node": "18.11.10",
-    "@typescript-eslint/eslint-plugin": "5.43.0",
-    "@typescript-eslint/parser": "5.20.0",
-    "eslint": "8.24.0",
+    "@types/mustache": "4.2.2",
+    "@types/node": "20.5.7",
+    "@typescript-eslint/eslint-plugin": "5.62.0",
+    "@typescript-eslint/parser": "5.54.1",
+    "eslint": "8.48.0",
     "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-jest": "27.1.1",
+    "eslint-plugin-jest": "27.2.1",
     "eslint-plugin-prettier": "4.2.1",
     "jest": "27.5.1",
     "jest-circus": "27.5.1",
     "nock": "13.2.9",
-    "prettier": "2.7.1",
+    "prettier": "2.8.4",
     "ts-jest": "27.1.4",
     "typescript": "4.9.3"
   }