Merge branch 'main' into smockle/fix-remove-deprecated-input

Author: smockle

.github/actions/auth/action.yml

@@ -17,7 +17,7 @@ outputs:
     description: "Stringified JSON object containing 'username', 'password', 'cookies', and/or 'localStorage' from an authenticated session"
 
 runs:
-  using: "node20"
+  using: "node24"
   main: "bootstrap.js"
 
 branding:

.github/actions/file/README.md

@@ -30,32 +30,20 @@ Files GitHub issues to track potential accessibility gaps.
 
 #### `findings`
 
-List of potential accessibility gaps (plus issue URLs), as stringified JSON. For example:
+**DEPRECATED: This output will be removed in `v2`.** List of potential accessibility gaps (plus issue URLs), as stringified JSON. For example:
 
 ```JS
 '[]'
 ```
 
 #### `closed_issues`
 
-List of closed issues’ `id`, `nodeId`, `url`, and `title`, as stringified JSON. For example: `'[{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},{"id":2,"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124","title":"Accessibility issue: 2"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
+**DEPRECATED: This output will be removed in `v2`.** List of closed issues’ `id`, `nodeId`, `url`, and `title`, as stringified JSON. For example: `'[{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},{"id":2,"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124","title":"Accessibility issue: 2"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
 
 #### `opened_issues`
 
-List of newly-opened issues’ `id`, `nodeId`, `url`, and `title`, as stringified JSON. For example: `'[{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},{"id":2,"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124","title":"Accessibility issue: 2"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
+**DEPRECATED: This output will be removed in `v2`.** List of newly-opened issues’ `id`, `nodeId`, `url`, and `title`, as stringified JSON. For example: `'[{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},{"id":2,"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124","title":"Accessibility issue: 2"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
 
 #### `repeated_issues`
 
-List of repeated issues’ `id`, `nodeId`, `url`, and `title`, as stringified JSON. For example: `'[{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},{"id":2,"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124","title":"Accessibility issue: 2"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
-
-#### `closed_issue_urls`
-
-**DEPRECATED: This output will be removed in `v2`.** List of URLs for closed issues, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
-
-#### `opened_issue_urls`
-
-**DEPRECATED: This output will be removed in `v2`.** List of URLs for newly-opened issues, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
-
-#### `repeated_issue_urls`
-
-**DEPRECATED: This output will be removed in `v2`.** List of URLs for repeated issues, as stringified JSON. For example: `'["https://github.com/github/docs/issues/123","https://github.com/github/docs/issues/124","https://github.com/github/docs/issues/126","https://github.com/github/docs/issues/127"]'`.
+**DEPRECATED: This output will be removed in `v2`.** List of repeated issues’ `id`, `nodeId`, `url`, and `title`, as stringified JSON. For example: `'[{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},{"id":2,"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124","title":"Accessibility issue: 2"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.

.github/actions/file/action.yml

@@ -17,24 +17,18 @@ inputs:
 
 outputs:
   findings:
-    description: "List of potential accessibility gaps (plus issue URLs), as stringified JSON"
+    description: "DEPRECATED: List of potential accessibility gaps (plus issue URLs), as stringified JSON"
   closed_issues:
-    description: "List of closed issues, as stringified JSON"
+    description: "DEPRECATED: List of closed issues, as stringified JSON"
   opened_issues:
-    description: "List of newly-opened issues, as stringified JSON"
+    description: "DEPRECATED: List of newly-opened issues, as stringified JSON"
   repeated_issues:
-    description: "List of repeated issues, as stringified JSON"
-  closed_issue_urls:
-    description: "DEPRECATED: List of URLs for closed issues, as stringified JSON"
-  opened_issue_urls:
-    description: "DEPRECATED: List of URLs for newly-opened issues, as stringified JSON"
-  repeated_issue_urls:
-    description: "DEPRECATED: List of URLs for repeated issues, as stringified JSON"
+    description: "DEPRECATED: List of repeated issues, as stringified JSON"
 
 runs:
-  using: "node20"
+  using: "node24"
   main: "bootstrap.js"
 
 branding:
   icon: "compass"
-  color: "blue"
+  color: "blue"

.github/actions/file/src/index.ts

@@ -40,15 +40,12 @@ export default async function () {
       },
     }
   });
+  /** @deprecated */
   const closedIssues: Issue[] = [];
+  /** @deprecated */
   const openedIssues: Issue[] = [];
+  /** @deprecated */
   const repeatedIssues: Issue[] = [];
-  /** @deprecated Use `closedIssues` instead. */
-  const closedIssueUrls: string[] = [];
-  /** @deprecated Use `openedIssues` instead. */
-  const openedIssueUrls: string[] = [];
-  /** @deprecated Use `repeatedIssues` instead. */
-  const repeatedIssueUrls: string[] = [];
 
   for (const cachedFinding of cachedFindings) {
     if (!findingsMap.has(`${cachedFinding.url};${cachedFinding.problemShort};${cachedFinding.html}`)) {
@@ -61,7 +58,6 @@ export default async function () {
           url: response.data.html_url,
           title: response.data.title,
         });
-        closedIssueUrls.push(response.data.html_url);
         core.info(`Closed issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
       } catch (error) {
         core.setFailed(`Failed to close issue for finding: ${error}`);
@@ -84,7 +80,6 @@ export default async function () {
           url: response.data.html_url,
           title: response.data.title,
         });
-        repeatedIssueUrls.push(response.data.html_url);
         core.info(`Repeated issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
       } else {
         // New finding was found in the latest run, so create its issue
@@ -94,7 +89,6 @@ export default async function () {
           url: response.data.html_url,
           title: response.data.title,
         });
-        openedIssueUrls.push(response.data.html_url);
         core.info(`Created issue: ${response.data.title} (${repoWithOwner}#${response.data.number})`);
       }
     } catch (error) {
@@ -103,6 +97,7 @@ export default async function () {
     }
   }
 
+  // Deprecated outputs
   core.setOutput("closed_issues", JSON.stringify(closedIssues));
   core.setOutput("opened_issues", JSON.stringify(openedIssues));
   core.setOutput("repeated_issues", JSON.stringify(repeatedIssues));
@@ -111,17 +106,10 @@ export default async function () {
   core.debug(`Output: 'opened_issues: ${JSON.stringify(openedIssues)}'`);
   core.debug(`Output: 'repeated_issues: ${JSON.stringify(repeatedIssues)}'`);
   core.debug(`Output: 'findings: ${JSON.stringify(findings)}'`);
-
-  // Deprecated outputs
-  core.setOutput("closed_issue_urls", JSON.stringify(closedIssueUrls));
-  core.setOutput("opened_issue_urls", JSON.stringify(openedIssueUrls));
-  core.setOutput("repeated_issue_urls", JSON.stringify(repeatedIssueUrls));
-  core.warning("The 'closed_issue_urls' output is deprecated and will be removed in v2. If you use the 'closed_issue_urls' output, please migrate to the 'closed_issues' output.");
-  core.debug(`Output: 'closed_issue_urls: ${JSON.stringify(closedIssueUrls)}'`);
-  core.warning("The 'opened_issue_urls' output is deprecated and will be removed in v2. If you use the 'opened_issue_urls' output, please migrate to the 'opened_issues' output.");
-  core.debug(`Output: 'opened_issue_urls: ${JSON.stringify(openedIssueUrls)}'`);
-  core.warning("The 'repeated_issue_urls' output is deprecated and will be removed in v2. If you use the 'repeated_issue_urls' output, please migrate to the 'repeated_issues' output.");
-  core.debug(`Output: 'repeated_issue_urls: ${JSON.stringify(repeatedIssueUrls)}'`);
+  core.warning("The 'closed_issues' output is deprecated and will be removed in v2.");
+  core.warning("The 'opened_issues' output is deprecated and will be removed in v2.");
+  core.warning("The 'repeated_issues' output is deprecated and will be removed in v2.");
+  core.warning("The 'findings' output is deprecated and will be removed in v2.");
 
   core.info("Finished 'file' action");
 }

.github/actions/find/action.yml

@@ -15,7 +15,7 @@ outputs:
     description: "List of potential accessibility gaps, as stringified JSON"
 
 runs:
-  using: "node20"
+  using: "node24"
   main: "bootstrap.js"
 
 branding:

.github/actions/fix/action.yml

@@ -13,7 +13,7 @@ inputs:
     required: true
 
 runs:
-  using: "node20"
+  using: "node24"
   main: "bootstrap.js"
 
 branding:

README.md

@@ -96,7 +96,7 @@ Trigger the workflow manually or automatically based on your configuration. The
 | `urls` | Yes | Newline-delimited list of URLs to scan | `https://primer.style`<br>`https://primer.style/octicons` |
 | `repository` | Yes | Repository (with owner) for issues and PRs | `primer/primer-docs` |
 | `token` | Yes | PAT with write permissions (see above) | `${{ secrets.GH_TOKEN }}` |
-| `cache_key` | No | Custom key for caching findings across runs<br>Allowed: `A-Za-z0-9._/-` | `cached_findings-main-primer.style.json` |
+| `cache_key` | Yes | Key for caching findings across runs<br>Allowed: `A-Za-z0-9._/-` | `cached_findings-main-primer.style.json` |
 | `login_url` | No | If scanned pages require authentication, the URL of the login page | `https://github.com/login` |
 | `username` | No | If scanned pages require authentication, the username to use for login | `some-user` |
 | `password` | No | If scanned pages require authentication, the password to use for login | `correct-horse-battery-staple` |

action.yml

@@ -13,8 +13,8 @@ inputs:
     description: "Personal access token (PAT) with fine-grained permissions 'contents: write', 'issues: write', and 'pull_requests: write'"
     required: true
   cache_key:
-    description: "Custom key for caching findings across runs"
-    required: false
+    description: "Key for caching findings across runs"
+    required: true
   login_url:
     description: "If scanned pages require authentication, the URL of the login page"
     required: false
@@ -35,21 +35,11 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - name: Generate cache key
-      id: cache_key
-      shell: bash
-      run: |
-        CACHE_KEY="${{ inputs.cache_key }}"
-        if [[ -z "$CACHE_KEY" ]]; then
-          # If cache_key is not provided, generate a default one using the branch name, replacing characters (e.g. `/`) which would create unexpected paths.
-          CACHE_KEY=$(printf 'cached_findings-%s' "${{ github.ref_name }}" | tr -cs 'A-Za-z0-9._-' '_')
-        fi
-        echo "cache_key=$CACHE_KEY" >> $GITHUB_OUTPUT
     - name: Restore cached_findings
       id: restore
       uses: ./.github/actions/gh-cache/cache
       with:
-        key: ${{ steps.cache_key.outputs.cache_key }}
+        key: ${{ inputs.cache_key }}
         token: ${{ inputs.token }}
     - if: ${{ inputs.login_url && inputs.username && inputs.password && !inputs.auth_context }}
       name: Authenticate
@@ -84,7 +74,7 @@ runs:
     - name: Save cached_findings
       uses: ./.github/actions/gh-cache/cache
       with:
-        key: ${{ steps.cache_key.outputs.cache_key }}
+        key: ${{ inputs.cache_key }}
         value: ${{ steps.file.outputs.findings }}
         token: ${{ inputs.token }}