https://github.com/trossr32/outdated-packages-action
Github action for reporting on outdated dotnet packages in a solution or npm packages in a project directory.
https://github.com/trossr32/outdated-packages-action
dotnet-outdated github-actions npm-outdated pull-requests
Last synced: about 1 year ago
JSON representation
Github action for reporting on outdated dotnet packages in a solution or npm packages in a project directory.
- Host: GitHub
- URL: https://github.com/trossr32/outdated-packages-action
- Owner: trossr32
- Created: 2023-12-10T23:38:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-21T00:43:26.000Z (over 2 years ago)
- Last Synced: 2025-02-05T19:36:02.865Z (over 1 year ago)
- Topics: dotnet-outdated, github-actions, npm-outdated, pull-requests
- Homepage:
- Size: 157 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# outdated-packages-action
Github action for reporting on outdated dotnet packages in a solution or project, or npm packages in a project directory.
## Overview
This action will run either or both of:
- dotnet-outdated against a supplied dotnet solution or project
- npm-update-check-action against a supplied npm project directory
> [!NOTE]
> The intention of this action is purely to notify of any outdated packages and _not_ to perform any kind of update action.
>
> Reports for any outdated packages found are added as a comment to the pull request used to run this action.
>
> If the action is re-run against a pull request that has already been commented on, the existing comment will be updated.
> [!WARNING]
> This action is designed to be actioned only within the context of a pull request, no other scenarios are catered for.
## Inputs
#### `use-dotnet-outdated`
**Optional** - Whether to run dotnet-outdated. Default `false`.
#### `dotnet-solution-or-project-path`
**Optional** - The path to the dotnet solution or project file. Required if `use-dotnet-outdated` is `true`.
#### `dotnet-exclude-packages`
**Optional** - Names of packages to exclude from the check. Optional if `use-dotnet-outdated` is `true`. Space delimited string of package names, e.g. "Microsoft.Extensions.Logging Microsoft.Extensions.Logging.Abstractions"
#### `dotnet-version`
**Optional** - The version of dotnet to use. Default `8.*.*`.
#### `use-npm-outdated`
**Optional** - Whether to run npm-update-check-action. Default `false`.
#### `npm-project-directory`
**Optional** - The path to the npm project directory. Default `.`.
#### `hide-successful-checks`
**Optional** - When true, don't add a success comment to the PR when checks are successful. Default `false`.
## Example github action
outdated.yml
```yaml
name: Outdated package checks
# Run workflow on pull request to the main branch
on:
pull_request:
types: [opened, synchronize, reopened]
branches: [ main ]
env:
SOLUTION_PATH: 'src/RobGreenEngineering.sln'
PROJECT_DIR: 'src/RobGreenEngineering'
EXCLUDE_PACKAGES: 'Microsoft.Extensions.Logging Microsoft.Extensions.Logging.Abstractions'
jobs:
outdated-packages-check:
runs-on: ubuntu-latest
# grant pull request write permission if 'Read and write permissions' is not active for actions in the repository
permissions:
pull-requests: write
steps:
- uses: trossr32/outdated-packages-action@v1.7.0
with:
# Whether to run dotnet-outdated. Default is false if not supplied.
use-dotnet-outdated: true
# The path to the dotnet solution or project file. Required if use-dotnet-outdated is true.
dotnet-solution-or-project-path: ${{ env.SOLUTION_PATH }}
# Names of packages to exclude from the check. Optional if use-dotnet-outdated is true.
# Space delimited string of package names, e.g. "Microsoft.Extensions.Logging Microsoft.Extensions.Logging.Abstractions"
dotnet-exclude-packages: ${{ env.EXCLUDE_PACKAGES }}
# The version of dotnet to use. Default is 8.*.*.
dotnet-version: '9.*.*'
# Whether to run npm-update-check-action. Default is false if not supplied.
use-npm-outdated: true
# The path to the npm project directory.
# Default is '.', so only required if the npm project is not the root of the repository.
npm-project-directory: ${{ env.PROJECT_DIR }}
# When true, don't add a success comment to the PR when checks are successful. Default is false if not supplied.
hide-successful-checks: false
```
## Example output
#### dotnet packages are outdated
#### dotnet packages up to date
#### npm packages are outdated
#### npm packages up to date
## Credit
This action leverages these projects:
- dotnet-outdated
- npm-update-check-action
- actions-comment-pull-request
- setup-dotnet
## Contribute
Please [create a pull request](https://github.com/trossr32/outdated-packages-action/compare) and get in touch. Alternatively feel free to [raise an issue](https://github.com/trossr32/outdated-packages-action/issues/new/choose) if you've found a bug or want to suggest a new feature.