kevincobain2000 / action-scc

Sloc, Cloc and Code Action to update README.md with code stats.

Home Page:https://coveritup.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

action-bar-scc

scc logo

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

- 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.

scc logo

Optional options

- 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 to generate the data.
  • This action uses instachart to generate the chart.
  • This action updates README.md with url of chart image. Or adds new at the top if first time.

About

Sloc, Cloc and Code Action to update README.md with code stats.

https://coveritup.app/

License:MIT License


Languages

Language:Go 94.9%Language:Shell 5.1%