Add the variables parameter in YAML format (#209)

Author: gorohash

.github/workflows/test.yml

@@ -114,3 +114,54 @@ jobs:
             previews:
             - merge-info
       - run: "echo merge state status: '${{ steps.test_with_mediaType_previews_yaml.outputs.data }}'"
+      - uses: ./
+        id: get_latest_release_with_variables_parameter
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          query: |
+            query release($owner:String!,$repo:String!) {
+              repository(owner:$owner,name:$repo) {
+                releases(first:1) {
+                  nodes {
+                    name
+                    createdAt
+                    tagName
+                    description
+                  }
+                }
+              }
+            }
+          variables: |
+            owner: ${{ github.event.repository.owner.name }}
+            repo: ${{ github.event.repository.name }}
+      - run: "echo latest release: '${{ steps.get_latest_release_with_variables_parameter.outputs.data }}'"
+      - id: get_commits_of_pull_request_with_variables_parameter
+        uses: ./
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          query: |
+            query pr_commits($pr_number: Int!) {
+              repository(owner: "octokit", name: "graphql-action") {
+                pullRequest(number: $pr_number) {
+                  commits(first: 10) {
+                    edges {
+                      node {
+                        commit {
+                          message
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          variables: |
+            pr_number: 1
+      - env:
+          JSON_DATA: ${{ steps.get_commits_with_variables_parameter.outputs.data }}
+        run: >
+          COMMITS_COUNT=$(echo ${JSON_DATA} | jq
+          '.repository.pullRequest.commits[] | length')
+          [[ ${COMMITS_COUNT} -eq 6 ]] && exit 0 || exit 1

README.md

@@ -42,6 +42,31 @@ jobs:
       - run: "echo 'latest release: ${{ steps.get_latest_release.outputs.data }}'"
 ```
 
+You can also use the `variables` parameter to pass variables.
+
+```yml
+- uses: octokit/[email protected]
+  with:
+    query: |
+      query release($owner:String!,$repo:String!) {
+        repository(owner:$owner,name:$repo) {
+          releases(first:1) {
+            nodes {
+              name
+              createdAt
+              tagName
+              description
+            }
+          }
+        }
+      }
+    variables: |
+      owner: ${{ github.event.repository.owner.name }}
+      repo: ${{ github.event.repository.name }}
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
 To access deep values of `outputs.data`, use [`fromJSON()`](https://docs.github.com/en/actions/learn-github-actions/expressions#fromjson).
 
 ## Debugging

action.yml

@@ -9,6 +9,8 @@ inputs:
     required: true
   mediaType:
     description: "Enable previews - see https://github.com/octokit/graphql-action/blob/main/README.md#preview-media-types"
+  variables:
+    description: "Variables described in YAML"
 outputs:
   data:
     description: 'The "data" key of the GraphQL response body'

index.js

@@ -45,6 +45,11 @@ function getAllInputs() {
       return result;
     }
 
+    if (inputName === `variables`) {
+      const variables = yaml.load(value);
+      return { ...result, ...variables };
+    }
+
     result[inputName] = yaml.load(value);
     result[inputName] =
       result[inputName] == parseInt(result[inputName], 10)