-
Notifications
You must be signed in to change notification settings - Fork 291
Create post-release activities skill #7485
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
Merged
+60
−0
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
3fb0dcf
Create post-release activities skill
Youssef1313 d17acc7
Partial progress
Youssef1313 8324cc8
Update SKILL.md
Youssef1313 ccbce75
Fix markdownlint
Youssef1313 a1192e0
Update SKILL.md
Youssef1313 0fc125c
Update SKILL.md
Youssef1313 c78d4f1
Update SKILL.md
Youssef1313 80171c5
Update .github/post-release-activities/SKILL.md
Youssef1313 99c715c
Update .github/post-release-activities/SKILL.md
Youssef1313 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| name: post-release-activities | ||
| description: Systematic activities that need to be performed after a release is done. | ||
| --- | ||
|
|
||
| # Post-release Activities Skill | ||
|
|
||
| ## When to Use This Skill | ||
|
|
||
| Use this skill when assigned an issue asking you to do the post-release activities. You will be given the branch name for the release. If that information is missing, ask for it and don't proceed with doing anything. | ||
|
|
||
| ## Steps to Follow | ||
|
|
||
| ### Step 1: Find the release version | ||
|
|
||
| The branch name only contains the major and minor parts of the version, but not the patch part. To find the full version: | ||
|
|
||
| 1. Look for `eng/Versions.props` file in the given branch. | ||
| 2. Find the value of `VersionPrefix`. | ||
|
|
||
| ### Step 2: Tagging the branch | ||
|
|
||
| Create a tag for the branch using the version you found in Step 1. The tag name should be `v{version}` (replace `{version}` with the version you found in Step 1). After creating the tag, push it to the remote repository. | ||
|
|
||
| ### Step 3: Create a GitHub draft release | ||
|
|
||
| 1. Create a file `release-notes.md` and add the following content to it: `See the release notes [here](https://github.com/microsoft/testfx/blob/main/docs/Changelog.md#{version})` (replace `{version}` with the version you found in Step 1). | ||
Youssef1313 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 2. Run `gh release create v{version} --draft --title v{version} --notes-file release-notes.md`. | ||
|
|
||
| ### Step 4: Open a PR to main updating the change log files | ||
|
|
||
| 1. Run the following command to get markdown of the changelog: `gh api --method POST -H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28" /repos/microsoft/testfx/releases/generate-notes -f 'tag_name=v{version}'` (replace `{version}` with the version you found in Step 1). | ||
| 2. Classify each entry as either an MSTest change or a Microsoft.Testing.Platform change. | ||
Youssef1313 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 3. MSTest changes go to `docs/Changelog.md` and Microsoft.Testing.Platform changes go to `docs/Changelog-Platform.md`. | ||
| 4. Classify further the changes of each product into categories like "Added", "Changed", "Fixed", etc. | ||
| 5. Update the changelog markdown files using the above instructions and following the existing format of those files. | ||
| 6. When not confident about the classification of a specific change, indicate in the PR description that it requires attention and manual review. This PR must target the `main` branch, not the release branch. | ||
|
|
||
| ### Step 5: Create a PR to release branch to update patch version | ||
|
|
||
| Open a PR to the release branch to update the patch version in `eng/Versions.props` file. The new patch version should be one more than the patch version you found in Step 1. | ||
|
|
||
| Note that in this step, both `TestingPlatformVersionPrefix` and `VersionPrefix` must be updated. | ||
|
|
||
| ### Step 6: Create a PR to main to update minor version | ||
|
|
||
| Open a PR to the main branch to update the minor version in `eng/Versions.props` file. The new minor version should be one more than the minor version you found in Step 1, and the patch version should be reset to 0. | ||
|
|
||
| Note that in this step, both `TestingPlatformVersionPrefix` and `VersionPrefix` must be updated. | ||
|
|
||
| ### Step 7: Update public samples | ||
|
|
||
| Open a PR to the main branch to update the product versions of public samples to latest. Public samples are present in `samples/public` directory. | ||
|
|
||
| ### Step 8: Mark APIs and analyzers as shipped | ||
|
|
||
| 1. Run `eng/mark-shipped.ps1` (requires PowerShell 7.0). | ||
| 2. Move the contents of `src/Analyzers/MSTest.Analyzers/AnalyzerReleases.Unshipped.md` (except the first two lines that start with `;`) to `src/Analyzers/MSTest.Analyzers/AnalyzerReleases.Shipped.md`. | ||
|
|
||
| Create a PR to main with these changes. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.