{"id":19881446,"url":"https://github.com/giscience/ors-config-migration","last_synced_at":"2026-02-16T10:19:27.736Z","repository":{"id":228799451,"uuid":"772118969","full_name":"GIScience/ors-config-migration","owner":"GIScience","description":"Tool for migrating ors-config.json files to ors-config.yml","archived":false,"fork":false,"pushed_at":"2024-12-04T15:47:17.000Z","size":128,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-09-18T21:42:40.973Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/GIScience.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-03-14T15:14:11.000Z","updated_at":"2024-12-04T15:47:23.000Z","dependencies_parsed_at":"2024-03-25T15:44:45.933Z","dependency_job_id":"09505b8e-2e31-49e4-acaa-f5eb4b140f21","html_url":"https://github.com/GIScience/ors-config-migration","commit_stats":null,"previous_names":["giscience/ors-config-migration"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GIScience/ors-config-migration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GIScience%2Fors-config-migration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GIScience%2Fors-config-migration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GIScience%2Fors-config-migration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GIScience%2Fors-config-migration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GIScience","download_url":"https://codeload.github.com/GIScience/ors-config-migration/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GIScience%2Fors-config-migration/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278173366,"owners_count":25942293,"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","status":"online","status_checked_at":"2025-10-03T02:00:06.070Z","response_time":53,"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-12T17:14:17.866Z","updated_at":"2025-10-03T13:59:44.033Z","avatar_url":"https://github.com/GIScience.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ors config migration\n\nthis is a tool for migrating from ors-config.json to ors-config.yml.\n\nAs with Release 8 a lot of config options have been restructured, this tool should help with\nmigrating configs from JSON to YAML format, inform about changes made and point out action steps\nthat need to be done manually.\n\n## Usage\n\nTo migrate your `ors-config.json`, run the following command in the folder with your config file,\nas the current directory is mounted into the container as a volume:\n\n```shell\ndocker run --rm -v ${PWD}:/app heigit/ors-config-migration \u003cors-source-major-version\u003e \u003cors-target-major-version\u003e \u003cpath-to-your-ors-config.yml|json\u003e\n# e.g.:\n# docker run --rm -v ${PWD}:/app heigit/ors-config-migration 7 8 ./ors-config.json\n# docker run --rm -v ${PWD}:/app heigit/ors-config-migration 8 9 ./ors-config.yml\n```\n\n\u003e Note: currently only migration from 7 to 8 and 8 to 9 are available.\n\nPlease examine the container logs carefully (should print to stdout) to see if there are any\nwarnings or errors concerning the migration and fix issues as needed.\n\nThe migrated `ors-config.yml` will be written to the current working directory.\n\n\n## Local usage with Python\n\nFor running the migration script locally you need at least Python version 3.11.\nClone the repository and run the following commands in the repo-root directory:\n\n```shell\n# create virtual python environment\npython3 -m venv .venv\n# activate venv\nsource .venv/bin/activate\n# install requirements\npython3 -m pip install -r requirements.txt\n# run migration script\npython3 migrate.py \u003cors-source-major-version\u003e \u003cors-target-major-version\u003e \u003cyour-ors-yml|json-config-path\u003e [\u003coptional-output-ors-yml-config-path\u003e]\n# e.g.:\n# python3 migrate.py 7 6 ./ors-config.json ./ors-config.yml\n# python3 migrate.py  8 9 ./ors-config.yml\n```\n\n## Local usage with Docker\n\nThe following will build the ors-config-migration docker image locally and run the migration script with the\nprovided `test-config.json` file.\nOnce the container finishes, the container will be removed and the `test-config.yml` file will be created in the local\nworking directory.\nClone the repository and run the following commands in the repo-root directory:\n\n```shell\n# Build the dockerfile\ndocker build -t ors-config-migration:local .\n# Change into a new working directory\nmkdir -p ./config \u0026\u0026 cd ./config\n# Execute the migration script by mounting the local working directory into the container\ndocker run --rm -v ${PWD}:/app ors-config-migration:local 7 8 config-files-json/test-config.json test-config.yml  \n```\n\n## Testing\n\nIf you want to run the schema tests locally:\n\n```shell\n# install pytest\npython3 -m pip install pytest\n\n# run tests\npython3 -m pytest tests\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiscience%2Fors-config-migration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgiscience%2Fors-config-migration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiscience%2Fors-config-migration/lists"}