release 2.48.0 #5414

Roger-Ethyca · 2024-10-23T19:55:41Z

Release Steps

We use GitHub’s release feature to tag releases that then get automatically deployed to DockerHub and PyPi via GitHub Actions. We also use a CHANGELOG.md to mitigate surprises to our users and help them plan updates accordingly. The release steps are as follows:

Major and Minor

Open a PR that is titled the version of the release (i.e. 1.6.0)
- Rename the Unreleased section of CHANGELOG.md to the new version number and put a date next to it
- Update the compare links for both the new version and for the new Unreleased section
Once approved, merge the PR
Create a new release, ensuring that the last PR to get merged is the aforementioned CHANGELOG.md update PR
Add the new version as the tag (i.e. 1.6.0)
Make the title the version with a v in front of it (i.e. v1.6.0)
Add a link to the CHANGELOG.md
Auto-populate the release notes
Publish the release

Patch

It may be necessary for a patch release to contain only select commits to the main branch since the last major or minor release. To create a release with only the desired changes, follow the steps below:

Checkout the most recent release's tag

To fetch the most recent tag's name, run:

# fides on main
git describe --abbrev=0 --tags

#=> 1.2.3

To checkout the most recent tag, run:

#fides on main
git checkout 1.2.3

#=> Note: switching to '1.2.3'.
#
# You are in 'detached HEAD' state. You can look around, make experimental
# changes and commit them, and you can discard any commits you make in this
# state without impacting any branches by switching back to a branch.
#
# If you want to create a new branch to retain commits you create, you may
# do so (now or later) by using -c with the switch command. Example:
#
# git switch -c <new-branch-name>
#
# Or undo this operation with:
#
# git switch -
#
# Turn off this advice by setting config variable advice.detachedHead to false
#
# HEAD is now at 0123abcd Commit Message

!!! tip
This can be combined into a single command:

 ```sh
 # fides on main
 git checkout $(git describe --abbrev=0 --tags)

 #=> Note: switching to '1.2.3'.
 #
 # You are in 'detached HEAD' state. You can look around, make experimental
 # changes and commit them, and you can discard any commits you make in this
 # state without impacting any branches by switching back to a branch.
 #
 # If you want to create a new branch to retain commits you create, you may
 # do so (now or later) by using -c with the switch command. Example:
 #
 # git switch -c <new-branch-name>
 #
 # Or undo this operation with:
 #
 # git switch -
 #
 # Turn off this advice by setting config variable advice.detachedHead to false
 #
 # HEAD is now at 0123abcd Commit Message
 ```

Create a new branch from the HEAD commit of the most recent release's tag, called release-v<tag>

# fides on tags/1.2.3
git checkout -b release-v1.2.4

#=> Switched to a new branch 'release-v1.2.4'

If the changes to be included in the patch release are contained in one or more unmerged pull requests, change the base branch of the pull request(s) to the release branch created in the previous step
Once approved, merge the pull request(s) into the release branch

Create a new branch off of the release branch by running:

# fides on release-v1.2.4
git checkout -b prepare-release-v1.2.4

#=> Switched to a new branch 'prepare-release-v1.2.4'

Optional: Incorporate any additional specific changes required for the patch release by running:
```
# fides on prepare-release-v1.2.4
git cherry-pick <commit>...
```
Copy the Unreleased section of CHANGELOG.md and paste above the release being patched
1. Rename Unreleased to the new version number and put a date next to it
2. Cut and paste the documented changes that are now included in the patch release to the correct section
3. Commit these changes
Open a pull request to incorporate any cherry-picked commits and the CHANGELOG.md changes into the release branch
1. Set the base branch of this pull request to the release branch
2. Once approved, merge the pull request into the release branch
Create a new release from the release branch
1. Add the new version as the tag (i.e. 1.2.4)
2. Title the release with the version number, prefixed with a v (i.e. v1.2.4)
3. Add a link to the CHANGELOG.md
4. Auto-populate the release notes
Publish the release
Merge the new release tag into main

!!! warning
Pushing commits (including merge commits) to the main branch requires admin-level repository permissions.
1. Checkout the main branch, and update the local repository:
```
git checkout main
#=> Switched to branch 'main'...

git pull
```
2. Merge the new release tag into main:
```
git merge tags/1.2.4
```
3. Handle any merge conflicts, and push to the remote main branch

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 the pull command 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

User Permissions

Verify user creation
Verify a Viewer can view all systems
Verify a Data Steward can edit systems they are assigned

Documentation

Verify that the CHANGELOG is formatted correctly and clean up verbiage where needed
Verify that the CHANGELOG is representative of the actual changes

⚠️ 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 Request section that includes a link back to the release PR (i.e., this one!) for tracking purposes
## QA Touch Test Run section that includes a link to the QATouch test run (QA team should provide this)

Post-Release Steps

vercel · 2024-10-23T19:55:46Z

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	Oct 24, 2024 8:32pm

cypress · 2024-10-23T20:06:57Z

fides Run #10629

Run Properties: Passed #10629 • e0b67b63d9: Submit form on Enter press (#5419)

Project	`fides`
Branch Review	`release-2.48.0`
Run status	`Passed #10629`
Run duration	`00m 40s`
Commit	`e0b67b63d9: Submit form on Enter press (#5419)`
Committer	`Jason Gill`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`0`
Pending	`0`
Skipped	`0`
Passing	`4`
⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results.
View all changes introduced in this branch ↗︎

cypress · 2024-10-23T21:14:42Z

fides Run #10615

Run Properties: Passed #10615 • e4b525057f ℹ️: Merge 9651a5b46dc9bd42a1092dfdcbc95ca2213f4c15 into 29c9c46221d53484dfd3819e64db...

Project	`fides`
Branch Review	`refs/pull/5414/merge`
Run status	`Passed #10615`
Run duration	`00m 36s`
Commit	`e4b525057f ℹ️: Merge 9651a5b46dc9bd42a1092dfdcbc95ca2213f4c15 into 29c9c46221d53484dfd3819e64db...`
Committer	`Roger Plotz`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`0`
Pending	`0`
Skipped	`0`
Passing	`4`
⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results.
View all changes introduced in this branch ↗︎

Co-authored-by: Kelsey Thomas <[email protected]>

codecov · 2024-10-24T16:59:08Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.85%. Comparing base (4abb9e6) to head (9651a5b).
Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5414   +/-   ##
=======================================
  Coverage   83.84%   83.85%           
=======================================
  Files         382      382           
  Lines       24073    24071    -2     
  Branches     2624     2624           
=======================================
- Hits        20185    20184    -1     
+ Misses       3306     3305    -1     
  Partials      582      582

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

empty commit to start release 2.48.0

61258c1

Revert changes to component theming (#5412)

dea08c1

vercel bot deployed to Preview October 23, 2024 21:02 View deployment

gilluminate and others added 3 commits October 23, 2024 17:59

Add Experience Config docs (#5405)

edbe12f

Co-authored-by: Kelsey Thomas <[email protected]>

HJ-103 - fix: Snowflake DSR integration fails with syntax error (#5417)

c3f992a

Update CHANGELOG.md

9651a5b

Submit form on Enter press (#5419)

e0b67b6

vercel bot deployed to Preview October 24, 2024 20:32 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

release 2.48.0 #5414

release 2.48.0 #5414

Roger-Ethyca commented Oct 23, 2024 •

edited

Loading

vercel bot commented Oct 23, 2024 •

edited

Loading

cypress bot commented Oct 23, 2024 •

edited

Loading

cypress bot commented Oct 23, 2024 •

edited

Loading

codecov bot commented Oct 24, 2024 •

edited

Loading

release 2.48.0 #5414

Are you sure you want to change the base?

release 2.48.0 #5414

Conversation

Roger-Ethyca commented Oct 23, 2024 • edited Loading

Release Steps

Major and Minor

Patch

Release Checklist

Pre-Release Steps

General

API

CLI

Privacy Center

Admin UI

User Permissions

Documentation

Publishing the release

Post-Release Steps

vercel bot commented Oct 23, 2024 • edited Loading

cypress bot commented Oct 23, 2024 • edited Loading

fides Run #10629

cypress bot commented Oct 23, 2024 • edited Loading

fides Run #10615

codecov bot commented Oct 24, 2024 • edited Loading

Codecov Report

Roger-Ethyca commented Oct 23, 2024 •

edited

Loading

vercel bot commented Oct 23, 2024 •

edited

Loading

cypress bot commented Oct 23, 2024 •

edited

Loading

cypress bot commented Oct 23, 2024 •

edited

Loading

codecov bot commented Oct 24, 2024 •

edited

Loading