{"id":19359817,"url":"https://github.com/codacy/codacy-usage-report","last_synced_at":"2026-06-22T10:31:26.291Z","repository":{"id":45650730,"uuid":"318238004","full_name":"codacy/codacy-usage-report","owner":"codacy","description":null,"archived":false,"fork":false,"pushed_at":"2021-12-02T16:03:44.000Z","size":4377,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":9,"default_branch":"master","last_synced_at":"2026-06-04T13:04:58.867Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/codacy.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":"2020-12-03T15:31:58.000Z","updated_at":"2023-06-10T08:57:47.000Z","dependencies_parsed_at":"2022-09-13T06:12:13.756Z","dependency_job_id":null,"html_url":"https://github.com/codacy/codacy-usage-report","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/codacy/codacy-usage-report","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-usage-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-usage-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-usage-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-usage-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codacy","download_url":"https://codeload.github.com/codacy/codacy-usage-report/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-usage-report/sbom","scorecard":{"id":295404,"data":{"date":"2025-08-11","repo":{"name":"github.com/codacy/codacy-usage-report","commit":"fef80cccff79326603ab808520cbd1c84ccc9238"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1","Warn: containerImage not pinned by hash: Dockerfile:19: pin your Docker image by updating alpine:3.12 to alpine:3.12@sha256:c75ac27b49326926b803b9ed43bf088bc220d22556de1bc5f72d742c91398f69","Info:   0 out of   2 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T19:22:20.835Z","repository_id":45650730,"created_at":"2025-08-17T19:22:20.835Z","updated_at":"2025-08-17T19:22:20.835Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34645681,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-22T02:00:06.391Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-10T07:16:15.738Z","updated_at":"2026-06-22T10:31:26.274Z","avatar_url":"https://github.com/codacy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# codacy-usage-report\n\ncodacy-usage-report is a script that generates a CSV file with the following activity information for each contributor that has their commits analyzed on Codacy:\n\n-   Date of creation\n-   Date of the last login\n-   Date of the last commit\n-   Number of commits\n-   Email addresses used on the commits\n-   Date of removal, if applicable\n-   If the contributor has an account on Codacy\n\nThe script obtains the information directly from your Codacy databases and can only be used on Codacy Self-hosted instances.\n\n## Requirements\n\nTo run codacy-usage-report you must have:\n\n-   [Codacy Self-hosted 3.1.0](https://docs.codacy.com/release-notes/self-hosted/self-hosted-v3.1.0/) or later\n-   Read access to the `account` and `analysis` Codacy databases from the environment where you will run codacy-usage-report\n-   Either [Go](https://golang.org/dl/) or [Docker](https://www.docker.com/) installed\n\n## Configuration\n\nCreate a configuration file `codacy-usage-report.yml` with the example syntax below.\n\n```yaml\naccountDB:\n  host: localhost\n  port: 5432\n  database: codacy\n  username: username\n  password: password\n  sslMode: require\nanalysisDB:\n  host: localhost\n  port: 5432\n  database: codacy\n  username: username\n  password: password\n  sslMode: require\n# You may need to lower the batch size from the default value\n# if you experience timeouts when running the script:\n# batchSize: 10000000\n```\n\nYou must have this configuration file in your current working directory or specify it with the flag `--configFile` when running codacy-usage-report.\n\n## Usage\n\n### Running codacy-usage-report using Go\n\nTo run codacy-usage-report directly using Go:\n\n1.  Install codacy-usage-report using Go:\n\n    ```bash\n    go get -u github.com/codacy/codacy-usage-report\n    ```\n\n2.  Run codacy-usage-report:\n\n    ```bash\n    codacy-usage-report\n    ```\n\n    **Note:** Make sure that you have [included the Go bin folder in your `PATH` environment variable](https://golang.org/doc/install#install).\n\n### Running codacy-usage-report using Docker\n\nAlternatively, you can run codacy-usage-report using Docker:\n\n```bash\ndocker run -v $PWD/codacy-usage-report.yml:/app/codacy-usage-report.yml \\\n           -v $PWD/codacy-usage-report:/app/result \\\n           codacy/codacy-usage-report:latest\n```\n\n### Command-line options\n\n```bash\ncodacy-usage-report [--configFile \u003cconfiguration file path\u003e]\n                    [--outputFolder \u003coutput folder path\u003e]\n                    [--help]\n```\n\n-   `--configFile`\n\n    Path of the `codacy-usage-report.yml` configuration file. The default is `./codacy-usage-report.yml`.\n\n-   `--outputFolder`\n\n    Path of the output folder to store the CSV file. The default is `./result/`.\n\n-   `--help`\n\n    Print usage information.\n\n## What is Codacy?\n\n[Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.\n\n### Among Codacy's features:\n\n-   Identify new Static Analysis issues\n-   Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)\n-   Auto-comments on Commits and Pull Requests\n-   Integrations with Slack, HipChat, Jira, YouTrack\n-   Track issues Code Style, Security, Error Proneness, Performance, Unused Code and other categories\n\nCodacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.\n\nCodacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.\n\n### Free for Open Source\n\nCodacy is free for Open Source projects.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodacy%2Fcodacy-usage-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodacy%2Fcodacy-usage-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodacy%2Fcodacy-usage-report/lists"}