Skip to content

docs: add env.py guide and update naming convention docs#9

Merged
AlexeyShalaev merged 1 commit into
masterfrom
docs/update-and-env-py
May 16, 2026
Merged

docs: add env.py guide and update naming convention docs#9
AlexeyShalaev merged 1 commit into
masterfrom
docs/update-and-env-py

Conversation

@AlexeyShalaev

Copy link
Copy Markdown
Contributor

Summary

  • Add new guide/env-py.md page explaining how to configure Alembic's env.py to work with alembic-gauntlet: injected connection / target_schema attributes, minimal working example, SET LOCAL vs SET danger callout, advisory locks, include_object filtering, credentials loading
  • Update guide/configuration.md: add missing allowed_fk_prefixes, allowed_check_*, allowed_uq_*, allowed_pk_* attributes; add section on auto-deriving rules from MetaData.naming_convention with resolution order table
  • Update guide/quickstart.md: replace outdated defaults list with a full table covering all constraint types; add mention of auto-derive and link to env.py guide
  • Add Configuring env.py entry to zensical.toml nav

@AlexeyShalaev AlexeyShalaev merged commit 84f5c6f into master May 16, 2026
6 checks passed
@AlexeyShalaev AlexeyShalaev deleted the docs/update-and-env-py branch May 16, 2026 19:27
@codecov

codecov Bot commented May 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

1 participant