{"repo":"ncruces/go-coverage-report","free":true,"listed":false,"github":"https://github.com/ncruces/go-coverage-report","clone":"git clone https://github.com/ncruces/go-coverage-report.git","description":"GitHub Action to add a coverage badge to your Go repo","language":"Shell","stars":88,"topics":["coverage","github-actions","go","golang"],"license":"MIT","category":"workflow-automation","readme_excerpt":"Go coverage report A GitHub Action to add a coverage [report][1], [badge][2], and [chart][4] to your Go repo. Apply it to your repo by adding this step to one of your workflows: Your repo needs to have a Wiki for the action to work, and workflows need to have read and write permissions to the repo. The action has 8 configuration knobs: - coverage-file : optional coverage input file; default is to generate coverage for all packages in the current module. - module-dir : optional module root directory, containing the go.mod file; default is the repository's root directory. - output-dir : optional output directory for the for the badge, report, chart; default is to generate files to the root of wiki. - badge-style : optional coverage badge style, generated by shields.io; one of: flat (default), flat-square , plastic , for-the-badge , social . - badge-title : optional coverage badge title; default is “coverage.” - report : default true , generate an [HTML coverage report][1]. - chart : default false , generate an [SVG coverage chart][4]. - amend : default false , amend your Wiki, avoiding a series of “Update coverage” commits. Also, consider: - running this step after your tests run - coverage will fail if any test fails, so you may skip it if they fail - running it only once per commit - use a condition to avoid repeated matrix runs - skipping it for PRs - PRs lack permission to update the Wiki, nor would you want unsubmitted PRs to do so - allowing it to fail without failing the","default_branch":null,"files":null,"tree":[],"storefront":"/r/ncruces","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ncruces/go-coverage-report/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}