{"id":13706998,"url":"https://github.com/codecheckers/register","last_synced_at":"2025-05-05T23:32:06.977Z","repository":{"id":49539570,"uuid":"241481531","full_name":"codecheckers/register","owner":"codecheckers","description":"Register of CODECHECK certificates","archived":false,"fork":false,"pushed_at":"2025-04-23T07:58:33.000Z","size":844912,"stargazers_count":6,"open_issues_count":58,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-26T10:57:13.255Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://codecheck.org.uk/register/","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codecheckers.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-18T22:30:11.000Z","updated_at":"2025-04-23T07:58:37.000Z","dependencies_parsed_at":"2022-08-29T16:40:46.150Z","dependency_job_id":"8b8dee4e-8de8-4ccd-a307-b5267903fd67","html_url":"https://github.com/codecheckers/register","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecheckers%2Fregister","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecheckers%2Fregister/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecheckers%2Fregister/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecheckers%2Fregister/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codecheckers","download_url":"https://codeload.github.com/codecheckers/register/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252593300,"owners_count":21773441,"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-08-02T22:01:14.518Z","updated_at":"2025-05-05T23:32:01.968Z","avatar_url":"https://github.com/codecheckers.png","language":"Makefile","funding_links":[],"categories":["Dockerfile"],"sub_categories":[],"readme":"# Register of CODECHECK certificates\n\nSee the register online at [**https://codecheck.org.uk/register/**](https://codecheck.org.uk/register/).\n\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4059767.svg)](https://doi.org/10.5281/zenodo.4059767)\n\n## Editing the register\n\nThe main register file is a simple CSV file, `register.csv` which connects the pieces published elsewhere to create a complete metadata set for each CODECHECK.\nThe CSV file should not unneedingly replicate information from elsewhere, especially from the CODECHECK configuration files (i.e., `codecheck.yml`).\nHere are some possible values or rules for the specific columns in the file:\n\n- `Certificate`: the certificate number\n- `Repository`: qualified reference to the repository where the `codecheck.yml` file can be retrieved; the file must be in the project \"root\"; supported types and examples:\n  - `github::` for referencing a GitHub repository using `org/name`, e.g., `github::codecheckers/Piccolo-2020` from codecheckers organisation\n  - `osf::` for referencing an OSF project using the project identifier, e.g.,  `osf::ZTC7M`\n- `Type`: type of the check, e.g., solicited as part of peer review in a journal or conference, or initiated from the community; possible values:\n  - `community` = check initiated independently by community members and following the [CODECHECK community workflow guide](https://codecheck.org.uk/guide/community-workflow); may be qualified further, e.g., for preprints as `community (preprint)`\n  - `journal (\u003cjournal abbreviation\u003e)` = check conducted as part of a peer review process with a scientific journal, including a reference to the check in the published article; the journal abbreviation uses the [ISO 4](https://en.wikipedia.org/wiki/ISO_4) standard name for the journal, using common capitalization and omitting full stops, for example `J Geogr Syst` or `GigaScience` (find the correct name via Wikipedia or the journal website)\n  - `conference (\u003cconf name\u003e)` = check conducted as part of a peer review process at a scientific conference, e.g., `conference (AGILEGIS)`\n- `Issue`: number of the issue in the register project where the CODECHECK is managed (informative mostly, not for metadata retrieval)\n\nTo update the register, simply edit the `register.csv` file and submit the change.\nA GitHub Action will apply the process outlined below for manual rendering to update the different representations of the register, including the website, in case the main register file changes.\n\n**Note:** The GitHub action requiest a `PAT` token to be added, because the default per-action-run token is not used by the R code that renders the package.\n\n## Deposit/archive\n\nThis repository is archived manually, in regular intervals, on Zenodo using the [GitHub-Zenodo-Integration](https://guides.github.com/activities/citable-code/).\nTo deposit a new version on Zenodo, create a new release following the naming scheme of previous releases.\nThen, go to the new record and manually make the following changes:\n\n- add the record to [the CODECHECK community](https://zenodo.org/communities/codecheck/) (if not already included)\n- change the record type to \"Dataset\"\n- update the ORCIDs and affiliations of authors\n- set the license to \"Open Data Commons Attribution License\"\n- update the Desription text (see previous records)\n- add \u003chttps://codecheck.org.uk/register/\u003e as a related identifier with \"is new version of this upload\"\n\n## Files in this repository\n\n- [`register.csv`](register.csv): the main file to edit to put a new certificate into the register\n- [`Makefile`](Makefile): common commands for managing the register\n- [`Dockerfile`](Dockerfile): Dockerfile for building and image to use in the GitHub action; needs to be build and pushed to Docker Hub\n- [`docs/register.md`](register.md): Markdown table of the register with additional metadata for checks\n- [`docs/register.json`](docs/register.json) and [`docs/featured.json`](docs/featured.json): JSON file with additional metadata for checks, whereas the \"featured\" file only contains the last ten codechecks; use for integration of CODECHECK metadata in third party services, APIs, etc.; public links: [https://codecheck.org.uk/register/register.json](https://codecheck.org.uk/register/register.json) and [https://codecheck.org.uk/register/featured.json](https://codecheck.org.uk/register/featured.json)\n- [`docs/index.html`](https://codecheck.org.uk/register): HTML rendering of the extended register\n\nThe above files are human-readable and machine-readable representations based on the register and metadata from the `codecheck.yml` files.\n\n_Do not edit any file in the `docs` directory by hand! Edit only `register.csv`._\n\n## Manual register rendering and checking\n\nThe representations above can also be generated manually using the following command from the [`codecheck` R package](https://github.com/codecheckers/codecheck):\n\n```bash\n# R -q -e \"remotes::install_github('codecheckers/codecheck')\"\n\nR -q -e \"codecheck::register_render(); warnings()\"\n```\n\nYou can also check the configuration files with\n\n```bash\nR -q -e \"codecheck::register_check(); warnings()\"\n```\n\nand clear the cache (in case you made a recent change to an online repo) with `R -q -e \"codecheck::register_clear_cache()\"`.\n\nTo fix problems with hitting the GitHub API rate limit on local register management, go to [your PAT page](https://github.com/settings/tokens) and save a PAT in the environment variable `GITHUB_PAT` to the file `.Renviron` next to this README file.\n\n## License\n\nThe data in this repository is published under a [Open Data Commons Attribution License](https://opendatacommons.org/licenses/by/summary/) (ODC-BY).\n\nThe code and documentation in this repository is published under the [MIT License](https://choosealicense.com/licenses/mit/).\n\nSee file [`LICENSE`](LICENSE) for details.\n\n------\n\n[About CODECHECK](https://codecheck.org.uk/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodecheckers%2Fregister","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodecheckers%2Fregister","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodecheckers%2Fregister/lists"}