Apply suggested changes

.github/actions/query_issues/action.yml

@@ -1,15 +1,16 @@
 name: Query issues using GraphQL API
 inputs:
-  token:
+  github_token:
-    description: 'The GITHUB_TOKEN secret'
+    description: 'GitHub API token'
     required: true
-  query:
+  filter:
-    description: "The GraphQL search query to be executed"
+    # Filter syntax: https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests
+    description: "The search filter for issues."
     required: true
     type: string
 outputs:
   query_result:
-    description: "The result of the query"
+    description: "The result of the query (JSON)"
     value: ${{ steps.get_issues.outputs.query_result }}
 
 runs:
@@ -18,23 +19,25 @@ runs:
     - id: get_issues
       shell: bash
       env:
-        GH_TOKEN: ${{ inputs.token }}
+        GH_TOKEN: ${{ inputs.github_token }}
       run: |
-        result="$(gh api graphql \
+        result="$(
-          --field search_query="${{ inputs.query }}" \
+          gh api graphql \
-          --raw-field query='
+            --field search_query="${{ inputs.query }}" \
-            query($search_query: String!, $cursor: String) {
+            --raw-field query='
-              search(first: 100, query: $search_query, type: ISSUE, after: $cursor) {
+              query($search_query: String!, $cursor: String) {
-                pageInfo {
+                search(first: 100, query: $search_query, type: ISSUE, after: $cursor) {
-                  hasNextPage,
+                  pageInfo {
-                  endCursor
+                    hasNextPage,
-                }
+                    endCursor
-                nodes {
+                  }
-                  ... on Issue {
+                  nodes {
-                    title
+                    ... on Issue {
-                    url
+                      title
+                      url
+                    }
                   }
                 }
-              }
+              }'
-            }')"
+            )"
         echo "query_result=$result" >> $GITHUB_OUTPUT

.github/actions/stale_issues/action.yml

@@ -1,13 +1,12 @@
-name: Filter stale issues
+name: Find stale issues
 inputs:
-  token:
+  github_token:
-    description: 'The GITHUB_TOKEN secret'
+    description: 'GitHub API token'
     required: true
-  period:
+  inactivity_period:
-    description: "The stale period in days"
+    description: "The inactivity period in days"
     required: false
     type: number
-    default: 14
   repo:
     description: "The target repository"
     required: false
@@ -15,35 +14,38 @@ inputs:
     default: "${{ github.repository_owner }}/${{ github.event.repository.name }}"
 outputs:
   result:
-    description: "The result of the query"
+    description: "List of issue URLs. The list is in a format suitable for iteration with a shell loop, i.e. escaped and separated with whitespace."
     value: ${{ steps.found_issues.outputs.result }}
 
 runs:
   using: "composite"
   steps:
-    - name: Get period date
+    - name: Get a concrete cut-off date matching the inactivity period
       id: date
       shell: bash
       run: |
-        period_date=$(date --date "${{ inputs.period }} days ago" --utc +"%Y-%m-%dT%H:%M:%SZ")
+        inactivity_period_date=$(date --date "${{ inputs.inactivity_period }} days ago" --utc +"%Y-%m-%dT%H:%M:%SZ")
-        echo "period=$period_date" >> $GITHUB_OUTPUT
+        echo "inactivity_period=$inactivity_period_date" >> $GITHUB_OUTPUT
+
     - name: Get inactive open issues
       id: stale_issues
       if: ${{ success() }}
       uses: ethereum/solidity/.github/actions/query_issues@develop
       with:
-        token: ${{ inputs.token }}
+        github_token: ${{ inputs.github_token }}
-        query: 'repo:${{ inputs.repo }} is:issue is:open updated:<${{ steps.date.outputs.period }}'
+        query: 'repo:${{ inputs.repo }} is:issue is:open updated:<${{ steps.date.outputs.inactivity_period }}'
+
     - name: Collect query result
       id: found_issues
       if: ${{ success() }}
       shell: bash
       run: |
         filter_result=$(
-          jq --raw-output \
+          jq \
-              --null-input \
+            --raw-output \
-              --argjson result '${{ steps.stale_issues.outputs.query_result }}' \
+            --null-input \
-              '[$result.data.search.nodes[].url] | @sh' \
+            --argjson result '${{ steps.stale_issues.outputs.query_result }}' \
-              | tr --delete \'
+            '[$result.data.search.nodes[].url] | @sh' \
+          | tr --delete \'
         )
         echo "result=$filter_result" >> $GITHUB_OUTPUT

.github/workflows/stale-issues.yml

@@ -1,4 +1,4 @@
-name: Check stale issues
+name: Ping and close stale issues
 
 on:
   workflow_dispatch: # FIXME: remove
@@ -6,8 +6,8 @@ on:
     - cron: '0 12 * * *'
 
 env:
-  PERIOD: 14 # in days
+  INACTIVITY_PERIOD: 14 # in days
-  WAIT_FOR_INFO: "waiting for more input"
+  WAIT_FOR_INFO_LABEL: "waiting for more input"
   DRY_RUN: true
 
 jobs:
@@ -16,12 +16,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+
       - name: Get inactive open issues
         id: stale_issues
         uses: ./.github/actions/stale_issues
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
-          period: ${{ env.PERIOD }}
+          inactivity_period: ${{ env.INACTIVITY_PERIOD }}
+
       - name: Comment on found issues
         if: ${{ success() }}
         env:
@@ -29,10 +31,12 @@ jobs:
         run: |
           for issue_url in ${{ steps.stale_issues.outputs.result }}; do
             # Filter stale issues that were triaged and are not waiting for more information
-            stale_triaged=$(gh issue view $issue_url \
+            is_stale=$(
-                                    --json labels \
+              gh issue view $issue_url \
-                                    --jq '.labels | map(.name != "$WAIT_FOR_INFO") | all and length > 0')
+                --json labels \
-            if [[ $stale_triaged == 'true' ]]; then
+                --jq '.labels | map(.name != "$WAIT_FOR_INFO_LABEL") | all and length > 0'
+              )
+            if [[ $is_stale == 'true' ]]; then
               if [[ $DRY_RUN == 'true' ]]; then
                 echo "Commenting on issue: $issue_url"
               else