{"id":22928734,"url":"https://github.com/uva-bi-sdad/auditor","last_synced_at":"2025-10-13T06:38:38.570Z","repository":{"id":61302792,"uuid":"530225214","full_name":"uva-bi-sdad/auditor","owner":"uva-bi-sdad","description":"A repository created to help double check and edit them before pushing them downstream","archived":false,"fork":false,"pushed_at":"2023-02-11T02:17:58.000Z","size":1798,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-07T10:29:52.588Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","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/uva-bi-sdad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":"audit.py","citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-29T13:10:46.000Z","updated_at":"2023-01-04T18:00:38.000Z","dependencies_parsed_at":"2023-02-11T20:15:47.751Z","dependency_job_id":null,"html_url":"https://github.com/uva-bi-sdad/auditor","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uva-bi-sdad%2Fauditor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uva-bi-sdad%2Fauditor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uva-bi-sdad%2Fauditor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uva-bi-sdad%2Fauditor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uva-bi-sdad","download_url":"https://codeload.github.com/uva-bi-sdad/auditor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246668905,"owners_count":20814744,"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":[],"created_at":"2024-12-14T09:27:39.139Z","updated_at":"2025-10-13T06:38:33.547Z","avatar_url":"https://github.com/uva-bi-sdad.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Auditor\n\nThis repo is canonically different than the testing that happends downstream because it is more intrusive and contains code that can edit/ clean up repositories before they get pushed to the public site\n\n1. Loops through all folders that match ```**/distribution/``` and creates a ```manifest.json``` at the root directory with the: hash, file size (bytes), and file path of each file.\n2. For each file added, search if there is a ```measures_info.json``` in the same directory, and check for a string match of the measure and the file name. If there is a match, append the data match from the ```measures_info.json``` on to the element in ```manifest.json```.\n\nThought process:\n---\n| Design | Pros | Cons | Mitigation\n| ---  | --- | --- | ---| \n| One public branch, default to main, with a development branch with data | Users can pull the data directly | Developers need to switch a branch before developing | Preventing a push to main would signal them to switch branches |\n|One public branch, default to development, with a distribution branch | Developers can develop on the main branch directly | \u003col\u003e \u003cli\u003e Users need to switch to the distribution branch to pull the repo without the extra data\u003c/li\u003e \u003cli\u003eDevelopers can accidentally push to the main branch\u003c/li\u003e\u003c/ol\u003e | \u003col\u003e\u003cli\u003eCan probably include a link in the README to the main branch\u003c/li\u003e\u003cli\u003eCan set a restriction on who pushes to the distribution branch to prevent accidental pushing and needing to merge backwards\u003c/li\u003e\u003c/ol\u003e |\n| Two repos both public | Developers can develop directly, and users can pull directly from the repo | \u003col\u003e\u003cli\u003e Users can see both branches and accidentally pull the one with data \u003c/li\u003e\u003cli\u003e Two branches are created for each repository \u003c/li\u003e\u003c/ol\u003e | \u003col\u003e\u003cli\u003eCan add in the README link to the data-less repo, or have a website that just points to the repos separately, or the name of the repo can include the type of repo it is \u003c/li\u003e\u003c/ol\u003e |\n|Two repos, one public one private | Users can pull the data directly, and developers can develop on the main branch directly | Loses transparency | The public repo can have a development branch that is one-to-one with the main branch of the private repo |\n\nTimeline:\n---\n- **2022-09-14**: Updating to track md5 on all files, but not check for measures unless it matches suffixes in the settings\n- **2022-09-07**: Auditor bug-fixes; split on ':' inside measure_info, and split on '.' for filename\n- **2022-08-29**: Add auditor and test one repo versus two repo models\n- **2022-08-23**: In the generation of the manifest, add in measure info data\n- **2022-08-04**: Check the data repository is created in the right format and create a manifest.json file\n\nNotes:\n---\n- Overleaf notes: https://www.overleaf.com/project/6306378e38071b727de6293e\n\nAction references:\n---\n- Dataverse-uploader action: https://github.com/IQSS/dataverse-uploader\n- Copy files to other repos action: https://github.com/derberg/copy-files-to-other-repositories\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuva-bi-sdad%2Fauditor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuva-bi-sdad%2Fauditor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuva-bi-sdad%2Fauditor/lists"}