{"id":15683577,"url":"https://github.com/tintinweb/solidity-metrics-action","last_synced_at":"2025-05-07T13:07:08.894Z","repository":{"id":46135828,"uuid":"514669907","full_name":"tintinweb/solidity-metrics-action","owner":"tintinweb","description":"📊 Generates Solidity Code Metrics Reports for Solidity Source Units in your Repository.","archived":false,"fork":false,"pushed_at":"2022-07-18T08:38:44.000Z","size":852,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-07T13:07:02.724Z","etag":null,"topics":["github-action","solidity"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/solidity-metrics-action","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tintinweb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-16T19:40:00.000Z","updated_at":"2025-01-10T00:39:52.000Z","dependencies_parsed_at":"2023-01-05T05:02:52.654Z","dependency_job_id":null,"html_url":"https://github.com/tintinweb/solidity-metrics-action","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"b9da385d9848ca236b49d64778fc2083b5c33cc2"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tintinweb%2Fsolidity-metrics-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tintinweb%2Fsolidity-metrics-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tintinweb%2Fsolidity-metrics-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tintinweb%2Fsolidity-metrics-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tintinweb","download_url":"https://codeload.github.com/tintinweb/solidity-metrics-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252883204,"owners_count":21819160,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-action","solidity"],"created_at":"2024-10-03T17:07:20.288Z","updated_at":"2025-05-07T13:07:08.870Z","avatar_url":"https://github.com/tintinweb.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"[\u003cimg width=\"200\" alt=\"get in touch with Consensys Diligence\" src=\"https://user-images.githubusercontent.com/2865694/56826101-91dcf380-685b-11e9-937c-af49c2510aa0.png\"\u003e](https://diligence.consensys.net)\u003cbr/\u003e\n\u003csup\u003e\n[[  🌐  ](https://diligence.consensys.net)  [  📩  ](https://github.com/ConsenSys/vscode-solidity-metrics/blob/master/mailto:diligence@consensys.net)  [  🔥  ](https://consensys.github.io/diligence/)]\n\u003c/sup\u003e\u003cbr/\u003e\u003cbr/\u003e\n\n\n# Solidity Metrics GitHub Action\n\nGenerate a Solidity Code Metrics HTML-Report for your Project. \n\n\u003csup\u003e\nPowered by \u003ca href=https://www.npmjs.com/package/solidity-code-metrics\u003esolidity-code-metrics\u003c/a\u003e.\n\u003c/sup\u003e\n\n\u003cimg width=\"607\" alt=\"image\" src=\"https://user-images.githubusercontent.com/2865694/179468873-fe7c5055-39a8-44f2-9a11-cc7ff467098b.png\"\u003e\n\n[Sample Report (html)](./sample/__metrics.html)\n\n## Usage\n\nInclude it in your GitHub Actions file after a checkout.\n\n```yaml\n- name: 📊 Crunch Numbers\n  uses: tintinweb/solidity-metrics-action@v1\n  id: metrics\n  with:\n      target: '{,**/}*.sol'\n```\n\nGenerates a HTML metrics report in the workspace root. The path can be accessed via `${{ steps.metrics.outputs.report }}` (by default: `__metrics.html`).\n\n## Example Job\n\n1. Checkout the codebase\n2. Generate the Metrics report (Note: `id: \u003cmetrics\u003e` allows us to access the generated report with `${{ steps.\u003cmetrics\u003e.outputs.report }}`).\n3. Upload `${{ steps.\u003cmetrics\u003e.outputs.report }}` as an artifact to the job\n\nThe `target` argument takes a single glob to select input files. By default it will try to load any `*.sol` file in the root or sub-paths (i.e. `{,**/}*.sol`).\n\n```yaml\nname: Metrics\n\non:\n  pull_request:\n    branches: [ master ]\n\njobs:\n  metrics:\n    name: 📊 Code Metrics\n    runs-on: ubuntu-latest\n    steps:\n      - name: Setup\n        uses: actions/checkout@v3\n      - name: 📊 Crunch Numbers\n        uses: tintinweb/solidity-metrics-action@v1\n        id: metrics\n        with:\n          target: '{,**/}*.sol'\n      - uses: actions/upload-artifact@v3\n        with:\n          name: metrics.html\n          path: ${{ steps.metrics.outputs.report }}\n```\n\n\u003cimg width=\"495\" alt=\"image\" src=\"https://user-images.githubusercontent.com/2865694/179473168-49b31ce3-4ef2-419b-aea8-e062e6674cbf.png\"\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftintinweb%2Fsolidity-metrics-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftintinweb%2Fsolidity-metrics-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftintinweb%2Fsolidity-metrics-action/lists"}