Skip to content

docs(controlplane): fix stale schema change instructions - #3456

Merged
migmartri merged 1 commit into
chainloop-dev:mainfrom
alucarded:docs/fix-stale-schema-migration-instructions
Sep 20, 2026
Merged

migmartri merged 1 commit into
chainloop-dev:mainfrom
alucarded:docs/fix-stale-schema-migration-instructions

Conversation

@alucarded

@alucarded alucarded commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

The control plane README tells contributors to create the versioned migration for an Ent schema change with make migration_new. That target stopped diffing the Ent schema in ef06a7c (#557, March 2024), when it became atlas migrate new and the diff behaviour moved to the new migration_sync target, which generate depends on. Following the step as written produces an empty migration file. The sentence has also been truncated mid-way since #220, with an unclosed backtick.

This documents the current procedure: make -C app/controlplane generate writes the migration via migration_sync, and the root make generate does not. It also notes that a data backfill is a separate, hand-written migration, as in #2454.

AI disclosure: this change was produced with AI assistance (Claude Code); the affected commit carries an Assisted-by trailer.

Review in cubic

The data model section told contributors to create the versioned
migration with make migration_new. That target stopped diffing the Ent
schema in ef06a7c (chainloop-dev#557, March 2024), where it became atlas migrate new
and the diff behaviour moved to migration_sync, which generate now
depends on. Following the step as written produces an empty migration.

Document the current procedure and note that a data backfill is a
separate, hand-written migration.

Assisted-by: Claude Code
Signed-off-by: Tomasz Edward Posluszny <tom@devpeer.net>
@chainloop-platform

chainloop-platform Bot commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Security Checks — ✅ 8 passing

✅ secret-scan

Status Policy Messages
✅ Passed secrets-detection -

✅ sast-scan

Status Policy Messages
✅ Passed owasp-top10-2025 -
✅ Passed sast -
✅ Passed cwe-top25 -
✅ Passed cwe-top26-40-cusp -

PR info

Status Policy Messages
✅ Passed pr-min-approvals -
✅ Passed pr-description-required -
✅ Passed pr-user-story-linked -

⏭️ 3 scans not applied

Scan Reason
vulnerability-scan no manifest/lockfile changed
github-actions-scan no workflow files changed
iac-scan no IaC files changed

View attestation ↗
View attestation ↗


Powered by Chainloop and Chainloop Trace

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@migmartri
migmartri merged commit 5f19918 into chainloop-dev:main Sep 20, 2026
16 checks passed
@migmartri

Copy link
Copy Markdown
Member

Thanks for your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants