Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libra-foundation/radon-comment
Comment a sumary of the radon output on a pull request.
https://github.com/libra-foundation/radon-comment
Last synced: 9 days ago
JSON representation
Comment a sumary of the radon output on a pull request.
- Host: GitHub
- URL: https://github.com/libra-foundation/radon-comment
- Owner: Libra-foundation
- License: mit
- Created: 2023-01-23T09:56:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-26T16:21:19.000Z (about 1 year ago)
- Last Synced: 2023-09-27T07:37:48.669Z (about 1 year ago)
- Language: TypeScript
- Size: 377 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Show Radon's metrics on your PRs
This action aims to convert the raw radon output into nicer comment on your PR so that you can keep track of all the great metrics radon produce.
We higly recommend you to check up [radon](https://pypi.org/project/radon/) if you do not know this tool.
## Usage:
```yml
name: Example
on:
pull_request:
branches: ["main"]
jobs:
comment:
permissions:
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Create Radon's reports
run: |
radon cc src/ -j >cc.json
radon mi src/ -j >mi.json
radon hal src/ -j >hal.json
- name: Comment the results on the PR
uses: Libra-foundation/[email protected]
with:
cc: "cc.json"
mi: "mi.json"
hal: "hal.json"
```
All the arguments are optionals and all the types of reports you give to the action will be processed and added to the comment.
We currently do not handle deltas but this feature is planned.