Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevincobain2000/action-scc
Sloc, Cloc and Code Action to update README.md with code stats.
https://github.com/kevincobain2000/action-scc
code codecount complexity count scanner scc sloc staticcodeanalysis
Last synced: about 1 month ago
JSON representation
Sloc, Cloc and Code Action to update README.md with code stats.
- Host: GitHub
- URL: https://github.com/kevincobain2000/action-scc
- Owner: kevincobain2000
- License: mit
- Created: 2023-12-30T13:58:39.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-06T21:23:08.000Z (almost 1 year ago)
- Last Synced: 2024-04-11T16:36:19.398Z (9 months ago)
- Topics: code, codecount, complexity, count, scanner, scc, sloc, staticcodeanalysis
- Language: Go
- Homepage: https://coveritup.app/
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
![action-bar-scc](https://instachart.coveritup.app/bar?data={"x":["YAML","Go"],"y":[[73,177],[0,2],[2,1],[0,36]],"names":["Code","Comment","Files","Complexity"]}&title=SCC+-+Sloc,+Cloc+and+Code&metric=+lines&width=960&height=700&subtitle=kevincobain2000@action-scc)
Sloc, Code, Complexity - Github action using scc
and instachart.
**Quick Setup:** Quickly add `scc` output as chart to your `README.md` with single action.
## Usage
```yaml
- uses: kevincobain2000/action-scc@v1
```
## Allow permissions
- Make sure you have `README.md` in your repo.
- Make sure `Settings > Actions > General` Workflow permissions - Read and write permissions are checked.
## Optional options
```yaml
- uses: kevincobain2000/action-scc@v1
with:
limit: 7 # Optional. Limit number of languages to show in chart (default is 7)
filename: README.md # Optional. File to update with chart (default is README.md)
width: 960 # Optional. Width of chart (default is 960)
height: 700 # Optional. Height of chart (default is 700)
instachart_url: # Optional. For self hosting charing service. (default is https://instachart.coveritup.app)
```
## Notes
- This action uses [scc](https://github.com/boyter/scc) to generate the data.
- This action uses [instachart](https://github.com/kevincobain2000/instachart) to generate the chart.
- This action updates `README.md` with url of chart image. Or adds new at the top if first time.