{"id":18793072,"url":"https://github.com/dsacms/repodive-tools","last_synced_at":"2025-04-11T02:34:14.417Z","repository":{"id":250917637,"uuid":"835852704","full_name":"DSACMS/repodive-tools","owner":"DSACMS","description":"Scripts and tools to gather information about git repositories.","archived":false,"fork":false,"pushed_at":"2025-02-13T21:04:19.000Z","size":314,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-24T23:51:38.506Z","etag":null,"topics":["cms-oss-tier1","dsacms-tier1"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DSACMS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-30T16:54:18.000Z","updated_at":"2025-02-13T21:04:22.000Z","dependencies_parsed_at":"2024-10-24T23:11:52.815Z","dependency_job_id":"6efacf23-b1ed-4515-a182-c9541f12e4fd","html_url":"https://github.com/DSACMS/repodive-tools","commit_stats":null,"previous_names":["dsacms/repodive-tools"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DSACMS%2Frepodive-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DSACMS%2Frepodive-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DSACMS%2Frepodive-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DSACMS%2Frepodive-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DSACMS","download_url":"https://codeload.github.com/DSACMS/repodive-tools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248329956,"owners_count":21085624,"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":["cms-oss-tier1","dsacms-tier1"],"created_at":"2024-11-07T21:23:26.369Z","updated_at":"2025-04-11T02:34:14.395Z","avatar_url":"https://github.com/DSACMS.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# repodive-tools\nScripts and tools to gather information about git repositories.\n\n## About the Project\nThis repository is a collection of scripts and tools for a given repodiving effort. Repodiving in this context means going through \na git repository and gathering relevant information for a specific purpose. \n\n\u003c!-- \n### Project Mission\n**{project mission}** --\u003e\n\n\n### Agency Mission\nWe're a group of civic-minded technologists transforming how the federal government delivers healthcare to the American people.\n\n\n### Team Mission\nEstablish and maintain guidance, policies, practices, and talent pipelines that advance equity, build trust, and amplify impact across CMS, HHS, and Federal Open Source Ecosystems by working and sharing openly.\n\n## Core Team\n\nA full list of contributors can be found on [https://github.com/DSACMS/repodive-tools/graphs/contributors](https://github.cms.gov/DSACMS/repodive-tools/graphs/contributors).\n\n\u003c!--\n## Documentation Index\n\nTODO: This is a like a 'table of contents\" for your documentation. Tier 0/1 projects with simple README.md files without many sections may or may not need this, but it is still extremely helpful to provide \"bookmark\" or \"anchor\" links to specific sections of your file to be referenced in tickets, docs, or other communication channels.\n\n**{list of .md at top directory and descriptions}**\n--\u003e\n\n\u003c!--\n## Repository Structure\n\nTODO: Using the \"tree -d\" command can be a helpful way to generate this information, but, be sure to update it as the project evolves and changes over time.\n\n**{list directories and descriptions}**\n--\u003e\n\n## Development and Software Delivery Lifecycle\nWe follow GitHub Flow with protected branches and pull request reviews. Development includes automated code analysis, security scanning, and adherence to CMS Open Source Policy guidelines. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.\n\n## Local Development\nTo run locally, please follow the instructions in [CONTRIBUTING.md](CONTRIBUTING.md) under Buidling the Project and Building Dependencies.\n\n\n## Usage\n\nRun SCC on repos:\n\n    1. Make sure that scc is installed on your machine\n    2. Set valid environment variables including GitHub token\n    3. `./run-scc-on-repos.sh \u003cDirectory to store GitHub code\u003e`\n\nNote: The SCC script will clone the repositories in the directory that you specify. If the \nrepository already exists in the directory then it will not download it again. This is useful \nfor if you want to re-use this directory to run the other scripts on it. \n\nGen Gource logs on repos:\n\n    1. Make sure that gource is installed on your machine\n    2. Set valid environment variables including GitHub token\n    3. `./gen-gource-logs-on-repos.sh \u003cDirectory to store GitHub code`\n\nNote: The gource script will clone the repositories in the directory that you specify. If the \nrepository already exists in the directory then it will not download it again. This is useful \nfor if you want to re-use this directory to run the other scripts on it. \n\n\nRun contributor resolution (rough):\n\n    1. `./run-contrib-resolution.sh \u003cDirectory with the GitHub Code already there\u003e`\n    3. Enter ctrl+d for any empty records that appear\n    4. `./concat.sh`\n    5. Look at merged_output.txt and enjoy!\n\n\nNote: this script assumes that all of the repositories have been cloned already.\n\n\n\u003c!--\n## Coding Style and Linters\n\nTODO - Add the repo's linting and code style guidelines\n\nEach application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before committing.\n--\u003e\n\n\u003c!--\n## Branching Model\n\nTODO - with example below:\nThis project follows [trunk-based development](https://trunkbaseddevelopment.com/), which means:\n\n* Make small changes in [short-lived feature branches](https://trunkbaseddevelopment.com/short-lived-feature-branches/) and merge to `main` frequently.\n* Be open to submitting multiple small pull requests for a single ticket (i.e. reference the same ticket across multiple pull requests).\n* Treat each change you merge to `main` as immediately deployable to production. Do not merge changes that depend on subsequent changes you plan to make, even if you plan to make those changes shortly.\n* Ticket any unfinished or partially finished work.\n* Tests should be written for changes introduced, and adhere to the text percentage threshold determined by the project.\n\nThis project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/workflows](.github/workflows) directory.\n\nPull-requests are merged to `main` and the changes are immediately deployed to the development environment. Releases are created to push changes to production.\n--\u003e\n\n\u003c!--\n## Contributing\nThank you for considering contributing to an Open Source project of the US Government! For more information about our contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).\n--\u003e\n\n\u003c!--\n## Codeowners\nThe contents of this repository are managed by **{responsible organization(s)}**. Those responsible for the code and documentation in this repository can be found in [CODEOWNERS.md](CODEOWNERS.md).\n--\u003e\n\n\u003c!--\n## Community\nThe repodive-tools team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.\n\nWe know that we can learn from a wide variety of communities, including those who will use or will be impacted by the tool, who are experts in technology, or who have experience with similar technologies deployed in other spaces. We are dedicated to creating forums for continuous conversation and feedback to help shape the design and development of the tool.\n\nWe also recognize capacity building as a key part of involving a diverse open source community. We are doing our best to use accessible language, provide technical and process documents, and offer support to community members with a wide variety of backgrounds and skillsets.\n--\u003e\n\n\u003c!--\n### Community Guidelines\nPrinciples and guidelines for participating in our open source community are can be found in [COMMUNITY_GUIDELINES.md](COMMUNITY_GUIDELINES.md). Please read them before joining or starting a conversation in this repo or one of the channels listed below. All community members and participants are expected to adhere to the community guidelines and code of conduct when participating in community spaces including: code repositories, communication channels and venues, and events.\n--\u003e\n\n\u003c!--\n## Feedback\nIf you have ideas for how we can improve or add to our capacity building efforts and methods for welcoming people into our community, please let us know at **{contact email}**. If you would like to comment on the tool itself, please let us know by filing an **issue on our GitHub repository.**\n--\u003e\n\n\u003c!--\n## Glossary\nInformation about terminology and acronyms used in this documentation may be found in [GLOSSARY.md](GLOSSARY.md).\n--\u003e\n\n## Policies\n\n### Open Source Policy\n\nWe adhere to the [CMS Open Source\nPolicy](https://github.com/CMSGov/cms-open-source-policy). If you have any\nquestions, just [shoot us an email](mailto:opensource@cms.hhs.gov).\n\n### Security and Responsible Disclosure Policy\n\n*Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.\n\nFor more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md).\n\n### Software Bill of Materials (SBOM)\n\nA Software Bill of Materials (SBOM) is a formal record containing the details and supply chain relationships of various components used in building software. \n\nIn the spirit of [Executive Order 14028 - Improving the Nation’s Cyber Security](https://www.gsa.gov/technology/it-contract-vehicles-and-purchasing-programs/information-technology-category/it-security/executive-order-14028), a SBOM for this repository is provided here: https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/network/dependencies.\n\nFor more information and resources about SBOMs, visit: https://www.cisa.gov/sbom.\n\n## Public domain\n\nThis project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/) as indicated in [LICENSE](LICENSE).\n\nAll contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsacms%2Frepodive-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsacms%2Frepodive-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsacms%2Frepodive-tools/lists"}