.Net outdated

This action checks for outdated dependencies in a .NET project or solution.

This action uses the dotnet list package command.

The action can add a comment to the pull request and create a check run with the a list of the outdated dependencies by project and framework.

Inputs

Name	Description	Value type	Required
add-pr-comment	A flag to indicate whether to add a comment to the associated PR with a report of the outdated packages. If this is enabled and the action is executed for a non-pull-request build then the comment will not be added. If this is enabled then the permission for pull-requests must be set to write i.e. pull-requests: write.	boolean	false
pr-comment-name	A unique suffix for the pull-request comment for the current run.	string	false
add-check-run	A flag to indicate whether to add a check run, to the action, containing a report of the outdated packages. If this is enabled then the permission for checks must be set to write i.e. checks: write.	boolean	false
fail-check-run-if-contains-outdated	A flag to indicate whether the check run should fail if there are any direct dependencies that are out of date. In order for this to work the check run needs to be enabled by setting add-check-run to be true.	boolean	false
check-run-name	A unique name for the check run tab.	string	false
include-transitive-dependencies	A flag to indicate whether to include transitive and top-level packages.	boolean	false
include-prerelease-dependencies	A flag to indicate whether to include prerelease packages as the target.	boolean	false
include-highest-minor-only	A flag to indicate whether to consider only the packages with a matching major version number when searching for newer packages.	boolean	false
include-highest-patch-only	A flag to indicate whether to consider only the packages with a matching major and minor version numbers when searching for newer packages.	boolean	false
nuget-sources	The NuGet sources to use when searching for newer packages. To specify more than one use a comma separated value.	csv string	false
nuget-config-file-path	The path to the NuGet config file to use.	string	false
frameworks	The framework or frameworks to run the command for. To specify more than one use a comma separated value.	csv string	false
target	The project or solution file to target. If a file is not specified, the command will search the current directory for one.	string	false

Environment variables

Name	Description	Required	Example
GITHUB_TOKEN	The GitHub actions token. This is required for the action to interact with the GitHub API	true	${{ secrets.GITHUB_TOKEN }}

Permissions

Minimal workflow job permissions

permissions:
  checks: write
  pull-requests: write

Required steps

It is required for the application to be restored before running this action. This can be done by adding a step to restore the project or solution.

Examples

Execute once in your pipeline

steps:
  - name: Restore
    run: dotnet restore
  - name: My action
    uses: gavanlamb/.net-vulnerable@latest
    with:
      add-pr-comment: true
      add-check-run: true
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Execute once in your pipeline

steps:
  - name: Restore
    run: dotnet restore
  - name: My action
    uses: gavanlamb/.net-vulnerable@latest
    with:
      add-pr-comment: true
      add-check-run: true
      frameworks: net5.0
      pr-comment-name: net5.0
      target: ./test.sln
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  - name: My action
    uses: gavanlamb/.net-vulnerable@latest
    with:
      add-pr-comment: true
      add-check-run: true
      frameworks: net6.0
      pr-comment-name: net6.0
      target: ./test.sln
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

How to contribute

If you would like to contribute please see CONTRIBUTING.