Skip to content

Conversation

@KevinMind
Copy link
Contributor

@KevinMind KevinMind commented Apr 16, 2025

Fixes: mozilla/addons#15559

Description

Add documentation for migrations and a workflow to comment a link to those docs on opened/reopened PRs that modify migration files.

Context

Every time github syncs a PR based on master, it will check if files changed in **/migrations/*.py. If it finds any of those files, it will add a comment on the PR linking to our migration docs and indicating caution should be taken to write safe and stable migrations.

image

Testing

Modifed a migration file and triggered the workflow, you can see the comment on the PR

Checklist

  • Add #ISSUENUM at the top of your PR to an existing open issue in the mozilla/addons repository.
  • Successfully verified the change locally.
  • The change is covered by automated tests, or otherwise indicated why doing so is unnecessary/impossible.
  • Add before and after screenshots (Only for changes that impact the UI).
  • Add or update relevant docs reflecting the changes made.

@KevinMind KevinMind force-pushed the kevinmind/addons/1559 branch 3 times, most recently from d5cd3ce to fd04360 Compare April 17, 2025 08:48
@mozilla mozilla deleted a comment from github-actions bot Apr 17, 2025
@KevinMind KevinMind force-pushed the kevinmind/addons/1559 branch from fd04360 to 8473567 Compare April 17, 2025 08:51
@mozilla mozilla deleted a comment from github-actions bot Apr 17, 2025
@KevinMind KevinMind force-pushed the kevinmind/addons/1559 branch from 8473567 to 9a220a5 Compare April 17, 2025 08:56
@github-actions
Copy link

github-actions bot commented Apr 17, 2025

⚠️ Data migration detected ⚠️

It looks like there are data migrations in your PR.
Please read our policies on database migrations before merging.

Migration Docs

@KevinMind KevinMind force-pushed the kevinmind/addons/1559 branch 3 times, most recently from ba26029 to e7d1174 Compare April 17, 2025 09:28
@KevinMind KevinMind force-pushed the kevinmind/addons/1559 branch from e7d1174 to 7d70905 Compare April 25, 2025 16:42
@diox diox closed this Oct 1, 2025
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.

[Task]: Update migration docs to be more explicit about expectations

3 participants