-
Notifications
You must be signed in to change notification settings - Fork 14
Migration Guide
To mitigate any potential hiccups when moving to the new repo, all contributors should clone the new project fresh, as if it was a brand new project.
Any pull requests open prior to March 29, 2025 have had their underlying code migrated to a branch with the naming convention of [Author username]/[original branch name]. To continue working on your pull request:
- Create a fork of the new repository
- Find your original branch based on your username
- File a new pull request from this branch
- Continue iterating on your pull request until it is ready to merge
If for some reason this process is not working for you, please reach out to a maintainer on the #wg-collectoss-8knot slack channel. We would love to help you continue working on your contributions
Scope: CollectOSS v1.0.0 (release notes · discussion). Low-risk drop-in: no API changes, no env-var renames, only minor migrations that don't touch data. The next release will rename
AUGUR_*env vars and PostgreSQL schemas — separate guide will follow.
Drop the v1.0.0 images into your existing docker-compose.yml:
-
ghcr.io/chaoss/collectoss:v1.0.0— backend -
ghcr.io/chaoss/collectoss-database:v1.0.0— PostgreSQL -
ghcr.io/chaoss/collectoss-keyman:v1.0.0— key orchestrator
Pin to :v1.0.0. Avoid :latest — future releases may ship migrations that touch your data, and pinning forces you through the release notes before upgrading.
Your existing .env works as-is in v1.0.0: AUGUR_* env vars and the augur_data / augur_operations / spdx schema names are unchanged, so existing volumes, queues, and passwords keep working.
Alembic auto-applies three migrations on first boot, none of which touch row data:
- Augur → CollectOSS rename in schema comments (#2)
- Loosened uniqueness on contributor alias emails (#288)
- Dropped an unused test table in
public(#281)
Stay on the Augur v0.92.0 rabbitmq image. The collectoss-rabbitmq image has baked-in credentials we don't recommend running with — the v1.0.0 backend is compatible with the Augur image, so there's no reason to swap it out yet.
core → database → keyman. Leave Redis and RabbitMQ alone.
The migrations don't modify row data, so the DB stays operationally fine for the old Augur image. But Alembic on Augur may refuse to start if it sees a newer stamped revision. If rollback doesn't come back cleanly, ask in #wg-collectoss-8knot rather than improvising — the fix depends on how far v1.0.0 got before breaking.
Bare-metal installs aren't supported. Ask in #wg-collectoss-8knot and we'll help you migrate to Docker.