Skip to content

Fix incorrect input name for upload-code-coverage action#44496

Closed
joshhale wants to merge 1 commit into
github:mainfrom
joshhale:joshhale/fix-coverage-action-input-name
Closed

Fix incorrect input name for upload-code-coverage action#44496
joshhale wants to merge 1 commit into
github:mainfrom
joshhale:joshhale/fix-coverage-action-input-name

Conversation

@joshhale
Copy link
Copy Markdown
Contributor

@joshhale joshhale commented May 29, 2026

Why:

The actions/upload-code-coverage@v1 action defines its input as file:, but the docs incorrectly show report:. Anyone copy-pasting the example gets a silently broken workflow since composite actions ignore unrecognized with: keys.

What's being changed (if available, include any code snippets, screenshots, or gifs):

Two occurrences of report: changed to file: in the code coverage setup guide (Step 2 snippet and full workflow example), matching the actual action.yml.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

The docs showed `report:` as the input for the coverage file path,
but the actual action (actions/upload-code-coverage) defines the input
as `file:`. Anyone copy-pasting the documented example would silently
lose their file path since composite actions ignore unrecognized inputs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 29, 2026 14:42
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label May 29, 2026
@github-actions
Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
code-security/how-tos/maintain-quality-code/set-up-code-coverage.md fpt
ghec
fpt
ghec

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@joshhale
Copy link
Copy Markdown
Contributor Author

Closing in favour of a PR in docs-internal per the Hubber contribution process.

@joshhale joshhale closed this May 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant