Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmu332233/action.similar-package-reviewer
A GitHub Action that provides a summary of similar packages detected by analyzing pull requests for new dependencies in Node.js projects, powered by ChatGPT
https://github.com/hmu332233/action.similar-package-reviewer
action actions chatgpt github-action github-actions hacktoberfest
Last synced: 4 days ago
JSON representation
A GitHub Action that provides a summary of similar packages detected by analyzing pull requests for new dependencies in Node.js projects, powered by ChatGPT
- Host: GitHub
- URL: https://github.com/hmu332233/action.similar-package-reviewer
- Owner: hmu332233
- License: mit
- Created: 2023-04-20T16:24:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-20T07:49:22.000Z (about 1 year ago)
- Last Synced: 2024-03-19T21:20:15.347Z (8 months ago)
- Topics: action, actions, chatgpt, github-action, github-actions, hacktoberfest
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/similar-package-reviewer
- Size: 515 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# action.similar-package-reviewer
A GitHub Action that provides a summary of similar packages detected by analyzing pull requests for new dependencies, effectively streamlining dependency management and preventing redundancy in Node.js projects, powered by ChatGPT
## Key Features
- 🧩 Automatically checks for newly installed packages in pull requests
- 🔍 Compares new packages to previously installed packages
- 📊 Generates a summary of similar packages detected during the comparison
- 🚀 Integrates seamlessly into GitHub Actions workflows and presents the summary as a job output
- ✨ Easily incorporate the results into other GitHub workflows or display them as a PR comment
To get started, simply add a new YAML workflow to your .github/workflows folder, and follow the Usage section in README.
## Usage
Add a new YAML workflow to your .github/workflows folder:
```yaml
name: 'Check Dependencies'
on:
pull_request:
types: [opened]
jobs:
compare:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Compare packages
id: compare-packages
uses: hmu332233/[email protected]
with:
openai_key: ${{ secrets.OPENAI_API_KEY }}
```
If you want, you can get a PR comment through output
```yaml
name: 'Check Dependencies And Create Comment'
on:
pull_request:
types: [opened]
jobs:
compare:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Compare packages
id: compare-packages
uses: hmu332233/[email protected]
with:
openai_key: ${{ secrets.OPENAI_API_KEY }}
- name: Create comment
uses: peter-evans/create-or-update-comment@v3
with:
issue-number: ${{ github.event.pull_request.number }}
body: |
${{ steps.compare-packages.outputs.results }}
```
## Prerequisites
Before using action.similar-package-reviewer, you need to have an OpenAI API key. If you don't have an API key yet, you can get one by signing up on the [OpenAI website](https://platform.openai.com/account/api-keys).
## Inputs
## Inputs
| Name | Description | Default | Required |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -------- |
| `openai_key` | openai api key | | Yes |
| `origin_branch` | The branch to be used as the base for comparison, typically the main branch of the project. Can be customized if needed. | origin/${{ github.base_ref }} | No |
| `target_branch` | The branch associated with the pull request, which contains the changes to be compared against the origin branch. Can be customized if needed. | origin/${{ github.head_ref }} | No |
| `model` | Specifies the ChatGPT model to be used for analyzing pull requests. Different models may provide varying levels of analysis accuracy and performance. | gpt-3.5-turbo | No |
| `use_functioncall` | Indicates whether to use the functioncall feature of ChatGPT. Using functioncall can provide more stable execution but may produce slightly different comparison results. | false | No |
## Outputs
| Name | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `results` | A summary of any similar packages detected during the comparison, intended to be posted as a comment on the pull request for review and consideration. |
## Contributing
Welcome contributions to action.similar-package-reviewer!
## License
action.similar-package-reviewer is released under the MIT. See [LICENSE](./LICENSE) for more details.