58 lines
2.4 KiB
YAML
58 lines
2.4 KiB
YAML
name: Migration Review
|
|
on:
|
|
pull_request_target:
|
|
types: [opened]
|
|
paths:
|
|
- 'ghost/core/core/server/data/schema/**'
|
|
- 'ghost/core/core/server/data/migrations/versions/**'
|
|
jobs:
|
|
createComment:
|
|
runs-on: ubuntu-latest
|
|
if: github.repository_owner == 'TryGhost'
|
|
name: Add migration review requirements
|
|
steps:
|
|
- uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
|
|
with:
|
|
script: |
|
|
github.rest.issues.addLabels({
|
|
issue_number: context.issue.number,
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
labels: ["migration"]
|
|
})
|
|
|
|
- uses: peter-evans/create-or-update-comment@57232238742e38b2ccc27136ce596ccae7ca28b4
|
|
with:
|
|
issue-number: ${{ github.event.pull_request.number }}
|
|
body: |
|
|
It looks like this PR contains a migration 👀
|
|
Here's the checklist for reviewing migrations:
|
|
|
|
### General requirements
|
|
|
|
- [ ] :warning: Tested performance on staging database servers, as performance on local machines is not comparable to a production environment
|
|
- [ ] Satisfies idempotency requirement (both `up()` and `down()`)
|
|
- [ ] Does not reference models
|
|
- [ ] Filename is in the correct format (and correctly ordered)
|
|
- [ ] Targets the next minor version
|
|
- [ ] All code paths have appropriate log messages
|
|
- [ ] Uses the correct utils
|
|
- [ ] Contains a minimal changeset
|
|
- [ ] Does not mix DDL/DML operations
|
|
- [ ] Tested in MySQL and SQLite
|
|
|
|
### Schema changes
|
|
|
|
- [ ] Both schema change and related migration have been implemented
|
|
- [ ] For index changes: has been performance tested for large tables
|
|
- [ ] For new tables/columns: fields use the appropriate predefined field lengths
|
|
- [ ] For new tables/columns: field names follow the appropriate conventions
|
|
- [ ] Does not drop a non-alpha table outside of a major version
|
|
|
|
### Data changes
|
|
|
|
- [ ] Mass updates/inserts are batched appropriately
|
|
- [ ] Does not loop over large tables/datasets
|
|
- [ ] Defends against missing or invalid data
|
|
- [ ] For settings updates: follows the appropriate guidelines
|