fides
fides copied to clipboard
Release 2.32.0
Release Checklist
The release checklist is a manual set of checks done before each release to ensure functionality of the most critical components of the application. Some of these steps are redundant with automated tests, while others are only tested here as part of this check.
This checklist should be copy/pasted into the final pre-release PR, and checked off as you complete each step.
Additionally, there is a robust Release Process page available in Confluence (internal only).
Pre-Release Steps
General
From the release branch, confirm the following:
- [ ] Quickstart works:
nox -s quickstart(verify you can complete the interactive prompts from the command-line) - [ ] Test environment works:
nox -s "fides_env(test)"(verify the admin UI on localhost:8080, privacy center on localhost:3001, CLI and webserver) - [ ] Have Roger run a QATouch automation run
Next, run the following checks via the test environment:
API
- [ ] Verify that the generated API docs are correct @ http://localhost:8080/docs
CLI
Run these from within the test environment shell:
- [ ]
git reset --hard- Note: This is required for thepullcommand to work - [ ]
fides user login - [ ]
fides push src/fides/data/sample_project/sample_resources/ - [ ]
fides pull src/fides/data/sample_project/sample_resources/ - [ ]
fides evaluate src/fides/data/sample_project/sample_resources/ - [ ]
fides generate dataset db --credentials-id app_postgres test.yml- Note: Because the filesystem isn't mounted, the new file will only show up within the container - [ ]
fides scan dataset db --credentials-id app_postgres
Privacy Center
- [ ] Every navigation button works
- [ ] DSR submission succeeds
- [ ] Consent request submission succeeds
Admin UI
- [ ] Every navigation button works
- [ ] DSR approval succeeds
- [ ] DSR execution succeeds
Documentation
- [ ] Verify that the CHANGELOG is formatted correctly and clean up verbiage where needed
- [ ] Verify that the CHANGELOG is representative of the actual changes
:warning: Note that any updates that need to be made to the CHANGELOG should not be commited directly to the release branch.
Instead, they should be committed on a branch off of main and then PR'd and merged into main, before being cherry-picked
over to the release branch. This ensures that the CHANGELOG stays consistent between the release branch and main.
Publishing the release
When publishing the release, be sure to include the following sections in the release description:
- [ ]
## Release Pull Requestsection that includes a link back to the release PR (i.e., this one!) for tracking purposes - [ ]
## QA Touch Test Runsection that includes a link to the QATouch test run (QA team should provide this)
Post-Release Steps
- [ ] Verify the ethyca-fides release is published to PyPi: https://pypi.org/project/ethyca-fides/#history
- [ ] Verify the fides release is published to DockerHub: https://hub.docker.com/r/ethyca/fides
- [ ] Verify the fides-privacy-center release is published to DockerHub: https://hub.docker.com/r/ethyca/fides-privacy-center
- [ ] Verify the fides-sample-app release is published to DockerHub: https://hub.docker.com/r/ethyca/fides-sample-app
- [ ] Smoke test the PyPi & DockerHub releases:
- [ ] Create a fresh venv with
python3 -m venv 2_12_0_venv - [ ] Activate the venv
source 2_12_0_venv/bin/activate - [ ]
pip install ethyca-fides - [ ]
fides deploy up
- [ ] Create a fresh venv with
- [ ] Announce the release!
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| fides-plus-nightly | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Mar 15, 2024 10:14pm |
Passing run #6818 ↗︎
| ⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results. | ||||
Details:
| OOB translations in admin UI (#4718) | |||
| Project: fides | Commit: 97dde00a68 |
||
| Status: Passed | Duration: 00:34 💡 | ||
| Started: Mar 22, 2024 3:41 AM | Ended: Mar 22, 2024 3:42 AM | ||
Review all test suite changes for PR #4705 ↗︎
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 86.60%. Comparing base (
ef34c89) to head (97dde00). Report is 16 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@
## main #4705 +/- ##
=======================================
Coverage 86.60% 86.60%
=======================================
Files 335 335
Lines 19924 19924
Branches 2549 2549
=======================================
Hits 17255 17255
Misses 2201 2201
Partials 468 468
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Passing run #6738 ↗︎
| ⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results. | ||||
Details:
| Merge 97dde00a6849e4be13a1b85522cac18ba635f9de into 7e576b54481665164dd67aef97a9... | |||
| Project: fides | Commit: 9a80b5e6c3 ℹ️ |
||
| Status: Passed | Duration: 00:35 💡 | ||
| Started: Mar 15, 2024 10:22 PM | Ended: Mar 15, 2024 10:22 PM | ||