DOC: Add Release Readiness step to release process docs#1450
Open
rlundeen2 wants to merge 2 commits intoAzure:mainfrom
Open
DOC: Add Release Readiness step to release process docs#1450rlundeen2 wants to merge 2 commits intoAzure:mainfrom
rlundeen2 wants to merge 2 commits intoAzure:mainfrom
Conversation
Add a new step 1 (Release Readiness) to the release process that includes pre-release checks: verifying pending changes with maintainers, confirming CI pipelines pass, ensuring pyrit-internal is up to date, and updating scorer metrics. Renumber all subsequent steps accordingly. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
rlundeen2
force-pushed
the
users/rlundeen/2026_03_10_release_process_update
branch
from
240601a to
749cbcb
Compare
ValbuenaVC
approved these changes
Mar 10, 2026
| ## 7. Test Built Package | ||
|
|
||
| This step is crucial to ensure that the new package works out of the box. | ||
| Create a new environment with `uv venv --python 3.11` |
Contributor
There was a problem hiding this comment.
Nit: Just realized this is hardcoded; should we tie this to something or just let it be 3.11 until we deprecate it?
|
|
||
| - **Check for pending changes.** Ask other PyRIT maintainers whether they have any in-flight changes that should land before the release. | ||
| - **Verify build pipelines.** Confirm that all integration tests and end-to-end tests are passing in the CI pipelines. If any tests are failing, fix them before proceeding. | ||
| - **Verify pyrit-internal is up to date.** Follow the instructions at [aka.ms/internal-release](https://aka.ms/internal-release) to ensure the internal package is current. |
Contributor
There was a problem hiding this comment.
Nit: should we be more explicit that this link is available only for Microsoft FTEs with repo access, or is that already obvious from the fact this is only for maintainers?
romanlutz
reviewed
Mar 10, 2026
|
|
||
| - **Check for pending changes.** Ask other PyRIT maintainers whether they have any in-flight changes that should land before the release. | ||
| - **Verify build pipelines.** Confirm that all integration tests and end-to-end tests are passing in the CI pipelines. If any tests are failing, fix them before proceeding. | ||
| - **Verify pyrit-internal is up to date.** Follow the instructions at [aka.ms/internal-release](https://aka.ms/internal-release) to ensure the internal package is current. |
Contributor
There was a problem hiding this comment.
Wouldn't that be post-release? Can't update pyrit-internal with the release version before releasing after all.
Contributor
Author
There was a problem hiding this comment.
ah good point, I was thinking about checking everything worked first, but probably makes more sense at the end so we can pin
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new Step 1: Release Readiness to the release process documentation with pre-release checks that should be completed before starting a release:
evaluate_scorers.pyand commit results to keep scorer metrics currentAll subsequent steps are renumbered (now 1–10 instead of 1–9) and internal cross-references are updated.