Resolve merge conflicts with actions/main

.github/copilot-instructions.md

@@ -0,0 +1,111 @@
+# Copilot Coding Agent Instructions
+
+Trust these instructions. Only search the codebase if information here is incomplete or found to be in error.
+
+## Repository Overview
+
+**dependency-review-action** is a GitHub Action (TypeScript/Node.js 24) that scans pull requests for dependency changes, raising errors for vulnerabilities or invalid licenses. It queries the GitHub Dependency Review API, evaluates changes against configured rules, and produces job summaries and PR comments. The action entry point is `dist/index.js` (bundled via `ncc`). The repo is small (~15 source files, ~15 test files).
+
+## Build & Validation Commands
+
+For CI-parity installs and local validation, run `npm ci --ignore-scripts` before other commands. This is the install step used in CI; release workflows may follow different install instructions (see CONTRIBUTING).
+
+| Task         | Command                   | Notes                                                                                                                                    |
+| ------------ | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| Install      | `npm ci --ignore-scripts` | ~45s. Use `--ignore-scripts` for CI-parity installs; release workflows may use `npm i` per CONTRIBUTING.                                 |
+| Build        | `npm run build`           | Compiles `src/*.ts` → `lib/*.js` via `tsc -p tsconfig.build.json`. ~5s.                                                                  |
+| Test         | `npm test`                | Runs Jest. ~8s. All tests should pass.                                                                                                   |
+| Lint         | `npm run lint`            | ESLint on `src/**/*.ts`. Ignore the TS version warning—it still passes.                                                                  |
+| Format check | `npm run format-check`    | Prettier check on `**/*.ts`.                                                                                                             |
+| Format fix   | `npm run format`          | Auto-fix formatting with Prettier.                                                                                                       |
+| Package      | `npm run package`         | Bundles the action entrypoint (`package.json#main`) → `dist/index.js` via `ncc`. ~7s. Do NOT include `dist/` changes in non-release PRs. |
+| All          | `npm run all`             | Runs: build → format → lint → package → test (in that order).                                                                            |
+
+### Validation Sequence After Making Changes
+
+Always run these commands in this order to validate changes:
+
+```sh
+npm run build
+npm run format-check
+npm run lint
+npm test
+```
+
+If format-check fails, run `npm run format` to auto-fix, then re-check.
+
+### CI Checks (`.github/workflows/ci.yml`)
+
+CI runs on PRs (excluding `**.md` changes) with Node 24:
+
+1. **test** job: `npm ci --ignore-scripts` → `npm test`
+2. **lint** job: `npm ci --ignore-scripts` → `npm run format-check` → `npm run lint`
+
+Additional workflows: `dependency-review.yml` (self-test), `codeql.yml` (CodeQL analysis), `stale.yaml` (stale issues).
+
+## Project Layout
+
+```
+src/                  # TypeScript source (edit these files)
+  main.ts             # Entry point — orchestrates the action (532 lines)
+  schemas.ts          # Zod schemas & TypeScript types for all data structures
+  config.ts           # Reads action inputs + external YAML config
+  dependency-graph.ts # GitHub API client for dependency diff
+  filter.ts           # Filters changes by severity, scope, allowed advisories
+  licenses.ts         # License validation against allow/deny lists
+  deny.ts             # Package/group deny-listing logic
+  purl.ts             # Package URL (PURL) parser
+  spdx.ts             # SPDX license expression handling
+  scorecard.ts        # OpenSSF Scorecard integration
+  summary.ts          # Summary/report generation (736 lines, largest module)
+  comment-pr.ts       # Posts/updates PR comments with results
+  git-refs.ts         # Resolves base/head git refs from event payload
+  utils.ts            # Shared utilities (Octokit client, grouping helpers)
+lib/                  # Compiled JS output (from `npm run build`). Gitignored.
+dist/                 # Bundled action (from `npm run package`). Committed but do NOT include changes in normal PRs - only pull requests which are creating new releases should have these files changed.
+__tests__/            # Jest test files (*.test.ts)
+  test-helpers.ts     # setInput()/clearInputs() helpers for test env vars
+  fixtures/           # YAML config samples and factory helpers
+    create-test-change.ts       # Factory for mock Change objects
+    create-test-vulnerability.ts # Factory for mock vulnerability objects
+scripts/              # Dev/debug utilities (scan_pr for manual testing, create_summary.ts for preview)
+action.yml            # Action metadata — inputs, outputs, and `runs.main: dist/index.js`
+```
+
+### Configuration Files
+
+| File                  | Purpose                                                                      |
+| --------------------- | ---------------------------------------------------------------------------- |
+| `tsconfig.json`       | Base TypeScript config (ES6 target, CommonJS, strict mode)                   |
+| `tsconfig.build.json` | Build config — extends base, includes only `src/`, outputs to `lib/`         |
+| `jest.config.js`      | Jest config — uses `ts-jest`, matches `**/*.test.ts`                         |
+| `.eslintrc.json`      | ESLint — `plugin:github/recommended`, strict TS rules, no semicolons         |
+| `.prettierrc.json`    | Prettier — no semis, single quotes, no bracket spacing, trailing comma: none |
+| `.prettierignore`     | Ignores `dist/`, `lib/`, `node_modules/`                                     |
+
+### Key TypeScript/Style Rules
+
+- No semicolons (enforced by ESLint and Prettier)
+- Single quotes, no trailing commas
+- `@typescript-eslint/no-explicit-any: error` — never use `any`
+- `@typescript-eslint/explicit-function-return-type: error` — all functions need return types (expressions exempt)
+- Unused function parameters/args must be prefixed with `_` (e.g. `_unused`); unused variables should be removed
+- Use Zod schemas (in `src/schemas.ts`) for all data validation and type definitions
+- Config option defaults belong in Zod schemas, NOT in `action.yml`
+
+### Testing Patterns
+
+- Tests use Jest with `ts-jest` transform — no build step needed before running tests
+- Use `__tests__/test-helpers.ts` `setInput(name, value)` to mock action inputs (sets `INPUT_*` env vars)
+- Use `__tests__/fixtures/create-test-change.ts` and `create-test-vulnerability.ts` for test data factories
+- Test files follow `__tests__/<module>.test.ts` naming convention
+- Tests run directly against TypeScript source (not compiled JS)
+
+### Important Notes
+
+- The action runs on `node24` (declared in `action.yml`)
+- Source imports often use relative `../src/` paths (e.g. `import {readConfig} from '../src/config'`)
+- Adding a new action input requires changes in: `action.yml` (input definition), `src/schemas.ts` (Zod schema with default), `src/config.ts` (reading the input), and relevant source/test files
+- `dist/index.js` is committed for GitHub Actions but PR contributors should NOT include `dist/` changes — maintainers handle rebuilding
+- The `lib/` directory is gitignored
+- Scorecard tests make real HTTP calls to `api.securityscorecards.dev` and `deps.dev`

.github/workflows/ci.yml

@@ -10,14 +10,17 @@ on:
     paths-ignore:
       - '**.md'
 
+permissions:
+  contents: read
+
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
         with:
-          node-version: 20
+          node-version: 24
           cache: npm
       - name: Install dependencies
         run: npm ci --ignore-scripts
@@ -27,10 +30,10 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
         with:
-          node-version: 20
+          node-version: 24
           cache: npm
       - name: Install dependencies
         run: npm ci --ignore-scripts

.github/workflows/codeql.yml

@@ -20,15 +20,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript-typescript', 'actions' ]
+        language: [ 'javascript-typescript', 'actions', 'ruby' ]
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
+      uses: github/codeql-action/init@v4
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -38,11 +38,11 @@ jobs:
         # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
         # queries: security-extended,security-and-quality
         config: |
-          paths-ignore: 
+          paths-ignore:
             - dist/index.js
             - dist/sourcemap-register.js
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3
+      uses: github/codeql-action/analyze@v4
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/dependency-review.yml

@@ -10,6 +10,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - name: Dependency Review
         uses: ./

.github/workflows/stale.yaml

@@ -12,7 +12,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/stale@v9.1.0
+    - uses: actions/stale@v10.2.0
       name: Clean up stale PRs and Issues
       with:
         stale-pr-message: "👋 This pull request has been marked as stale because it has been open with no activity for 180 days. You can: comment on the PR or remove the stale label to hold stalebot off for a while, add the `Keep` label to hold stale off permanently, or do nothing. If you do nothing, this pull request will be closed eventually by the stalebot. Please see CONTRIBUTING.md for more policy details."

CONTRIBUTING.md

@@ -25,11 +25,11 @@ If you'd like to make a contribution yourself, we ask that before significant ef
 
 ## Stalebot
 
-We have begun using a [Stalebot action](https://github.com/actions/stale) to help keep the Issues and Pull requests backlogs tidy. You can see the configuration [here](.github/workflows/stalebot.yml). If you'd like to keep an issue open after getting a stalebot warning, simply comment on it and it'll reset the clock.
+We have begun using a [Stalebot action](https://github.com/actions/stale) to help keep the Issues and Pull requests backlogs tidy. You can see [the configuration](.github/workflows/stalebot.yml). If you'd like to keep an issue open after getting a stalebot warning, simply comment on it and it'll reset the clock.
 
 ## Development lifecycle
 
-Ready to contribute to `dependency-review-action`?  Here is some information to help you get started.
+Ready to contribute to `dependency-review-action`? Here is some information to help you get started.
 
 ### High level overview of the action
 
@@ -50,10 +50,9 @@ Before you begin, you need to have [Node.js](https://nodejs.org/en/) installed,
 
 #### Manually testing for vulnerabilities
 
-We have a script to scan a given PR for vulnerabilities, this will
-help you test your local changes. Make sure to [grab a Personal Access Token (PAT)](https://github.com/settings/tokens) before proceeding (you'll need `repo` permissions for private repos):
+We have a script to scan a given PR for vulnerabilities, which will help you test your local changes. Make sure to [grab a Personal Access Token (PAT)](https://github.com/settings/tokens) before proceeding (you'll need `repo` permissions for private repos):
 
-<img width="480" alt="Screenshot 2022-05-12 at 10 22 21" src="https://user-images.githubusercontent.com/2161/168026161-16788a0a-b6c8-428e-bb6a-83ea2a403070.png">
+<img width="480" alt="Screen to create a PAT with a note of `dr-token`, 30 day duration (expiring Jun 11, 2022), with `repo` scopes selected" src="https://user-images.githubusercontent.com/2161/168026161-16788a0a-b6c8-428e-bb6a-83ea2a403070.png">
 
 The syntax of the script is:
 
@@ -87,8 +86,9 @@ _Note_: We don't have a very comprehensive test suite, so any contributions to t
 
 1. Create a new branch: `git checkout -b my-branch-name`
 2. Make your change, add tests, and make sure the tests still pass
-3. Make sure to build and package before pushing: `npm run build && npm run package`
-4. Push to your fork and [submit a pull request][pr]
+3. Push to your fork and [submit a pull request][pr]
+
+(note: we don't recommend including changes to the `dist` directory in your pull request, because changes there have an increased likelihood of conflicts.)
 
 Here are a few things you can do that will increase the likelihood of your pull request being accepted:
 
@@ -105,40 +105,38 @@ Here are a few things you can do that will increase the likelihood of your pull
 
 _Note: these instructions are for maintainers_
 
-1. Update the version number in [package.json](https://github.com/actions/dependency-review-action/blob/main/package.json) and run `npm i` to update the lockfile.
-1. Go to [Draft a new
-   release](https://github.com/actions/dependency-review-action/releases/new)
-   in the Releases page.
-1. Make sure that the `Publish this Action to the GitHub Marketplace`
-   checkbox is enabled
+- Create a local branch based on the `main` of the upstream repo.
+- Update the version number in [package.json](https://github.com/actions/dependency-review-action/blob/main/package.json) and run `npm i` to update the lockfile.
+- Update the dist files by running `npm run build` and `npm run package`
+- Submit a PR based on your branch and have another maintainer review/approve it.
+- Once merged, go to [Draft a new release](https://github.com/actions/dependency-review-action/releases/new) in the Releases page.
+- Make sure that the `Publish this Action to the GitHub Marketplace` checkbox is enabled
+
+<img width="481" alt="Screen showing Release Action with Publish this Action to the GitHub Marketplace checked" src="https://user-images.githubusercontent.com/2161/173822484-4b60d8b4-c674-4bff-b5ff-b0c4a3650ab7.png">
 
-<img width="481" alt="Screenshot 2022-06-15 at 12 08 19" src="https://user-images.githubusercontent.com/2161/173822484-4b60d8b4-c674-4bff-b5ff-b0c4a3650ab7.png">
+- Click "Choose a tag" and then "Create new tag", where the tag name
+  will be your version prefixed by a `v` (e.g. `v1.2.3`).
+- Use a version number for the release title (e.g. "1.2.3").
 
-3. Click "Choose a tag" and then "Create new tag", where the tag name
-   will be your version prefixed by a `v` (e.g. `v1.2.3`).
-4. Use a version number for the release title (e.g. "1.2.3").
+<img width="700" alt="Create an action release in categories Security + Dependency management from branch main creating tag v2.0.0 on publish" src="https://user-images.githubusercontent.com/2161/173822548-33ab3432-d679-4dc1-adf8-b50fdaf47de3.png">
 
-<img width="700" alt="Screenshot 2022-06-15 at 12 08 36" src="https://user-images.githubusercontent.com/2161/173822548-33ab3432-d679-4dc1-adf8-b50fdaf47de3.png">
+- Add your release notes. If this is a major version make sure to include details about any breaking changes in the new version.
+- Click "Publish Release".
 
-5. Add your release notes. If this is a major version make sure to
-   include a small description of the biggest changes in the new version.
-6. Click "Publish Release".
+You now have a tag and release using the semver version you used above. The last remaining thing to do is to update the major version branch to match the current release. This allows users to adopt a major version number (e.g. `v4`) in their workflows while automatically getting all the minor/patch updates.
 
-You now have a tag and release using the semver version you used
-above. The last remaining thing to do is to move the dynamic version
-identifier to match the current SHA. This allows users to adopt a
-major version number (e.g. `v1`) in their workflows while
-automatically getting all the
-minor/patch updates.
+As of v4.8.3, we use a **branch** (not a force-pushed tag) for the major version pointer. This is important because force-pushing tags breaks GitHub's auto-generated release changelog links (see [#1035](https://github.com/actions/dependency-review-action/issues/1035)) and violates git's (unenforced) expectation that tags are immutable.
 
-To do this just checkout `main`, force-create a new annotated tag, and push it:
+To update the major version branch:
 
 ```
-git tag -fa v4 -m "Updating v4 to 4.0.1"
-git push origin v4 --force
+git checkout main
+git pull origin main
+git branch -f v4 HEAD
+git push origin v4
 ```
-</details>
 
+</details>
 
 ## Resources