https://github.com/react-navigation/check-versions-action
Check for missing or outdated versions of packages mentioned in the issue
https://github.com/react-navigation/check-versions-action
Last synced: 30 days ago
JSON representation
Check for missing or outdated versions of packages mentioned in the issue
- Host: GitHub
- URL: https://github.com/react-navigation/check-versions-action
- Owner: react-navigation
- Created: 2020-04-20T02:07:11.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T13:03:07.000Z (over 2 years ago)
- Last Synced: 2024-05-19T05:18:44.182Z (12 months ago)
- Language: JavaScript
- Size: 1.03 MB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Check versions action
This action checks for missing or outdated versions of packages mentioned in the issue.
## How it works
The action will check the issue content for name of packages and try to extract the version numbers. If some of the packages are missing version numbers or don't match the latest version numbers on npm, then it'll comment on the issue.
## Installation
Create a new workflow file (e.g. `.github/workflows/check-versions.yml`) and add the following configuration:
```yml
name: Check versions
on:
issues:
types: [opened]
jobs:
check-versions:
runs-on: ubuntu-latest
steps:
- uses: react-navigation/[email protected]
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
required-packages: |
@react-navigation/native
optional-packages: |
@react-navigation/bottom-tabs
@react-navigation/drawer
@react-navigation/stack
missing-versions-label: 'needs more info'
```
Make sure to change the `packages` list and the `missing-versions-label`.
## Inputs
### `github-token` (`required`)
The `GITHUB_TOKEN` secret. This is needed so that we can post comments on the issue.
### `required-packages`
List of required packages to check for. The action will match the content of the issue against these package names to find mentioned versions. If the packages are not mentioned or their version is not mentioned in the issue, the action will mark them as missing.
### `optional-packages`
List of optional packages to check for. The action will match the content of the issue against these package names to find mentioned versions. If there are packages present in the issue, but not mentioned in this list, then they will be ignored.
### `comment`
Boolean to indicate whether the action should comment on the issue on finding missing or outdated versions. Defaults to `true`.
Set it to `false` if you want to use the action as a filter.
### `missing-versions-label`
Label to add when missing or outdated versions are found.
## Outputs
### `found`
Packages and version numbers found. It'll be formatted like `@react-navigation/[email protected],@react-navigation/[email protected]`.
### `outdated`
Packages with outdated versions and their latest versions. It'll be formatted like `@react-navigation/[email protected],@react-navigation/[email protected]`.
### `missing`
Packages missing version numbers. It'll be formatted like `@react-navigation/stack,@react-navigation/native`.