Skip to content

Commit d9f1b4c

Browse files
authored
add pr templates with extension upgrade checklist (#706)
1 parent 2db9f56 commit d9f1b4c

File tree

3 files changed

+68
-0
lines changed

3 files changed

+68
-0
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## What kind of change does this PR introduce?
2+
3+
Bug fix, feature, docs update, ...
4+
5+
## What is the current behavior?
6+
7+
Please link any relevant issues here.
8+
9+
## What is the new behavior?
10+
11+
Feel free to include screenshots if it includes visual changes.
12+
13+
## Additional context
14+
15+
Add any other context or screenshots.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## What kind of change does this PR introduce?
2+
3+
- upgrade _extension_ from _v0.0.0_ to _v0.0.0_
4+
5+
## Additional context
6+
7+
Add any other context or screenshots.
8+
9+
## Action Items
10+
11+
- [ ] **New extension releases** were Checked for any breaking changes
12+
- [ ] **Extensions compatibility** Checked
13+
* Proceed to [extensions compatibility testing](#extensions-compatibility-testing), mark as done after everything is completed
14+
- [ ] **Backup and Restore** Checked
15+
* Proceed to [backup testing](#backup-testing) while extensions are enabled
16+
- After every restore, re-run the tests specified at point [3.1](#extensions-compatibility-testing)
17+
18+
### Extensions compatibility testing
19+
20+
1. Enable every extension
21+
1. Check Postgres’ log output for any error messages while doing so
22+
1. This might unearth incompatibilities due to unsupported internal functions, missing libraries, or missing permissions
23+
2. Disable every extension
24+
1. Check Postgres’ log output for any cleanup-related error messages
25+
3. Re-enable each extension
26+
1. Run basic tests against the features they offer, e.g.:
27+
1. `pg_net` - execute HTTP requests
28+
2. `pg_graphql` - execute queries and mutations
29+
3. …to be filled in
30+
31+
### Backup Testing
32+
33+
Follow the testing steps steps for all the following cases:
34+
35+
- Pause on new Postgres version, restore on new Postgres version
36+
- Pause on older Postgres version, restore on new Postgres version
37+
- Run a single-file backup backup, restore the backup
38+
39+
#### Testing steps
40+
41+
1. Generate dummy data
42+
* the ‘Countries’ or ‘Slack clone’ SQL editor snippets are decent datasets to work with, albeit limited
43+
2. Save a db stats snapshot file
44+
* Do this by running `supa db-stats gather -p <project_ref>`
45+
3. Backup the database, through pausing the project, or otherwise
46+
4. Restore the backup, through unpausing the project or cli
47+
5. Check the data has been recovered successfully
48+
1. Visual checks/navigating through the tables works
49+
2. Run `supa db-stats verify` against the project and the previously saved file

.github/pull_request_template.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Please go the the `Preview` tab and select the appropriate sub-template:
2+
3+
* [Default](?expand=1&template=default.md)
4+
* [Extension Upgrade](?expand=1&template=extension_upgrade.md)

0 commit comments

Comments
 (0)