feat: ✨ add option to customize variable name for the output

Author: JamesIves

.github/workflows/integration.yml

@@ -31,6 +31,14 @@ jobs:
           save-name: todo
           retry: true
 
+      - name: Access environment variable output
+        run: |
+          echo "${fetchApiData}"
+
+      - name: Access step output
+        run: |
+          echo "Output: ${{ steps.validate.outputs.fetchApiData }}"
+
       - name: Build and Deploy Repo 🚀
         uses: JamesIves/github-pages-deploy-action@v4
         with:
@@ -39,16 +47,6 @@ jobs:
           target-folder: data
           ssh-key: ${{ secrets.DEPLOY_KEY }}
 
-      - name: Access environment variable output
-        if: always()
-        shell: bash
-        run: |
-          echo "${env.fetchApiData}"
-
-      - name: Access step output
-        run: |
-          echo "Output: ${{ steps.validation.outputs.fetchApiData }}"
-
   refresh-api-data-modified-formatting-encoding:
     runs-on: ubuntu-latest
     needs: refresh-api-data
@@ -69,15 +67,26 @@ jobs:
           retry: true
 
       - name: Fetch Base64 Data 📦
+        id: validate
         uses: JamesIves/fetch-api-data-action@v2
         with:
           endpoint: https://base64endpoint-hfdurtfq9iyz.runkit.sh/
           save-location: fetch-api-data-custom-encoding
           save-name: base64endpointdata
           encoding: base64
           format: txt
+          variable-name: CATS
           retry: true
 
+      - name: Access environment variable output
+        run: |
+          echo "${CATS}"
+
+      - name: Access step output
+        run: |
+          echo "Output: ${{ steps.validate.outputs.fetchApiData }}"
+
+
       - name: Build and Deploy Repo 🚀
         uses: JamesIves/github-pages-deploy-action@v4
         with:

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
 
+  variable-name:
+    description: 'You can override the name of the variable name the action exports. This will work so long as set-output is true.'
+    required: false
+
   set-output:
     description: '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.'
     required: false
@@ -54,5 +58,5 @@ inputs:
     required: false
 
 outputs:
-  fetch-api-data:
+  fetchApiData:
     description: 'The requested data from the API stored as a string.'

src/constants.ts

@@ -18,12 +18,14 @@ export interface ActionInterface {
   saveLocation?: string
   /** The save name of the exported file. */
   saveName?: string
-  /** Determines if the output shoudl be saved or not. */
+  /** Determines if the output should be saved or not. */
   setOutput: boolean
   /** The format of the file being saved. */
   format?: string
   /** Optional configuration that allows the fetch request to make a series of retry requests before failing. */
   retry?: boolean | null
+  /** The variable name the data exports as. */
+  variableName?: string
 }
 
 export interface DataInterface {
@@ -54,6 +56,8 @@ export interface ExportInterface {
   setOutput: boolean
   /** The format of the file to save. */
   format?: string
+  /** The variable name the data exports as. */
+  variableName?: string
 }
 
 // Required action data that gets initialized when running within the GitHub Actions environment.
@@ -74,7 +78,8 @@ export const action = {
   setOutput: !isNullOrUndefined(getInput('set-output'))
     ? getInput('set-output').toLowerCase() === 'true'
     : false,
-  format: getInput('format')
+  format: getInput('format'),
+  variableName: getInput('variable-name')
 }
 
 /** Status codes for the action. */

src/fetch.ts

@@ -74,13 +74,18 @@ export async function generateExport({
   format,
   saveLocation,
   saveName,
-  setOutput
+  setOutput,
+  variableName
 }: ExportInterface): Promise<Status> {
   info('Saving the data... 📁')
   const file = `${saveLocation ? saveLocation : 'fetch-api-data-action'}/${
     saveName ? saveName : 'data'
   }.${format ? format : 'json'}`
   const dataEncoding = encoding ? encoding : 'utf8'
+  const defaultVariableName = 'fetchApiData'
+  const environmentVariableName = variableName
+    ? variableName
+    : defaultVariableName
 
   try {
     await mkdirP(`${saveLocation ? saveLocation : 'fetch-api-data-action'}`)
@@ -89,8 +94,8 @@ export async function generateExport({
     info(`Saved ${file} 💾`)
 
     if (setOutput) {
-      exportVariable('fetchApiData', data)
-      setEnvironmentOutput('fetchApiData', data)
+      exportVariable(environmentVariableName, data)
+      setEnvironmentOutput(defaultVariableName, data)
     }
 
     return Status.SUCCESS