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

Add documentation for updating the package #46

Closed
joshuadavidthomas opened this issue Oct 19, 2023 · 1 comment · Fixed by #53
Closed

Add documentation for updating the package #46

joshuadavidthomas opened this issue Oct 19, 2023 · 1 comment · Fixed by #53

Comments

@joshuadavidthomas
Copy link
Member

joshuadavidthomas commented Oct 19, 2023

Since this package is designed to be used in a distributed fashion and involves models and the potential for migrations, we should document how to go about updating the package.

Any changes to the models that will involve migrations should be split across (at least) two releases:

  1. an initial release that contains the changes in a backwards compatible way and a deprecation warning
  2. a major release bump along with removing the deprecated old code.

IMO this is unlikely to happen as I think the models are pretty stable, however it should be documented now as to get ahead of it just in case. May be a bit of YAGNI, but better to do it than not.

@joshuadavidthomas
Copy link
Member Author

The order of updating is important too. I think the recommendation should be that the Docker image or Django app running the relay service should be updated first, then any Django projects using the relay service as an email backend should follow shortly afterwards.

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 a pull request may close this issue.

1 participant