Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 2.23.3 #4398

Closed
wants to merge 26 commits into from
Closed

Release 2.23.3 #4398

wants to merge 26 commits into from

Conversation

Kelsey-Ethyca
Copy link
Contributor

@Kelsey-Ethyca Kelsey-Ethyca commented Nov 7, 2023

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

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

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

Kelsey-Ethyca and others added 21 commits October 25, 2023 17:54
…twice instead (#4365)

Co-authored-by: Allison King <allisonjuliaking@gmail.com>
* feat: give the option to escape HTML in templates

* fix: escape HTML in HTML DSR reports

* fix: static checks

* feat: use Jinja autoescape

* docs: update changelog
Copy link

vercel bot commented Nov 7, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
fides-plus-nightly ⬜️ Ignored (Inspect) Visit Preview Nov 8, 2023 2:56am

@Kelsey-Ethyca Kelsey-Ethyca marked this pull request as ready for review November 7, 2023 21:32
@adamsachs adamsachs mentioned this pull request Nov 7, 2023
8 tasks
Copy link
Contributor

@NevilleS NevilleS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@Kelsey-Ethyca Kelsey-Ethyca deleted the release-2.23.3 branch June 19, 2024 00:32
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.

10 participants