Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add doco for db changes #3721

Merged

Conversation

boc-the-git
Copy link
Collaborator

What type of PR is this?

  • documentation

What this PR does / why we need it:

Adds some documentation for how to go about DB changes.
I wrote this ages ago as part of #2930 which is on hold, so splitting it out separately to unblock the docs.

Which issue(s) this PR fixes:

None.

Copy link
Collaborator

@Kuchenpirat Kuchenpirat left a comment

Choose a reason for hiding this comment

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

#3437 added task py:migrate

Might be good to use that in the dev guide as it sets the appropriate flags automatically and we can extend that if needed in the future.

mealie/Taskfile.yml

Lines 150 to 154 in 21f1d46

py:migrate:
desc: generates a new migration file e.g. task py:migrate:generate "add new column"
cmds:
- poetry run alembic revision --autogenerate -m "{{ .CLI_ARGS }}"
- task: py:format

@boc-the-git
Copy link
Collaborator Author

#3437 added task py:migrate

Might be good to use that in the dev guide as it sets the appropriate flags and we can extend that if needed in the future.

py:migrate:

Good spot. Updated.

Copy link
Collaborator

@Kuchenpirat Kuchenpirat left a comment

Choose a reason for hiding this comment

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

Looks Good 👍

@Kuchenpirat Kuchenpirat merged commit 2a6bb7d into mealie-recipes:mealie-next Jun 10, 2024
11 checks passed
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.

None yet

2 participants