Update README.md #6624
Merged
Update README.md #6624
Conversation
This file contains 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
sk593
reviewed
Nov 1, 2023
|
|
||
| 1. Cherry-pick the `version.yaml` changes and release notes onto the branch from the PR opened against main. This will ensure that the release notes are included in the release branch. [Example](https://github.com/radius-project/radius/pull/6114/files). The release branch should now contain all needed patch changes, an updated release version, and patch release notes. | ||
| 1. Cherry-pick the `version.yaml` changes and release notes onto the branch from the PR opened against the main. This will ensure that the release notes are included in the release branch. [Example](https://github.com/radius-project/radius/pull/6114/files). The release branch should now contain all needed patch changes, an updated release version, and patch release notes. |
sk593
reviewed
Nov 1, 2023
|
|
||
| 1. Push the commits to the remote and create a pull request targeting the release branch. | ||
| ```bash | ||
| git push origin <USERNAME>/<BRANCHNAME> | ||
| ``` | ||
|
|
||
| 1. Merge the release branch PR into the release branch (this is the branch with the patch changes, updated patch version, and release notes). Then, merge the PR created against `main` into the main branch (this will only contain the updated patch version and the release notes). The release branch changes must be merged before the PR is merged into main since the workflow in the main branch builds the release based on the head of the release branch. If the changes are not merged first to the release branch and then to the main branch, the patch release will not contain the necessary code fixes. | ||
| 1. Merge the release branch PR into the release branch (this is the branch with the patch changes, updated patch version, and release notes). Then, merge the PR created against `main` into the main branch (this will only contain the updated patch version and the release notes). The release branch changes must be merged before the PR is merged into the main since the workflow in the main branch builds the release based on the head of the release branch. If the changes are not merged first to the release branch and then to the main branch, the patch release will not contain the necessary code fixes. |
sk593
previously approved these changes
Nov 1, 2023
ytimocin
force-pushed
the
ytimocin/release-doc-update
branch
from
1bc8d01 to
4ac4e2a
Compare
Test Results3 003 tests ±0 2 991 ✔️ ±0 3m 5s ⏱️ +24s Results for commit 57b2d93. ± Comparison against base commit 3c6d337. This pull request removes 2 and adds 2 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
|
For the detailed report, please go to
|
willdavsmith
approved these changes
Nov 1, 2023
kachawla
approved these changes
Nov 1, 2023
Signed-off-by: Yetkin Timocin <ytimocin@microsoft.com> Signed-off-by: ytimocin <ytimocin@microsoft.com>
ytimocin
force-pushed
the
ytimocin/release-doc-update
branch
from
4ac4e2a to
57b2d93
Compare
|
For the detailed report, please go to
|
willdavsmith
pushed a commit
to willdavsmith/radius
that referenced
this pull request
Nov 3, 2023
# Description Update release doc. ## Type of change - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional). ## Auto-generated summary <!-- copilot:all --> ### <samp>🤖 Generated by Copilot at 1bc8d01</samp> ### Summary :pencil2::memo::heavy_check_mark: <!-- 1. :pencil2: - This emoji represents the correction of typos, spelling, and grammar errors. For example, line 9 was changed from "This document describes how to contribute to the releases of the project." to "This document describes how to contribute to the project's releases." 2. :memo: - This emoji represents the improvement of formatting, style, and consistency. For example, line 15 was changed from "The project follows the [Semantic Versioning](https://semver.org/) convention for its releases." to "The project follows the [Semantic Versioning](https://semver.org/) (SemVer) convention for its releases." to introduce the acronym for later use. 3. ✔️ - This emoji represents the clarification and enhancement of the information and instructions. For example, line 25 was changed from "The project uses [GitHub milestones](https://docs.github.com/en/github/managing-your-work-on-github/about-milestones) to track the progress and scope of each release." to "The project uses [GitHub milestones](https://docs.github.com/en/github/managing-your-work-on-github/about-milestones) to track the progress and scope of each release. Each milestone corresponds to a specific version number and release date." to provide more details and context. --> Fix documentation errors in `contributing-releases` guide. This improves the readability and accuracy of the guide for contributors and users. > _We are the ones who fix the docs_ > _We purge the errors from the text_ > _We wield the power of the backticks_ > _We make the releases shine and flex_ ### Walkthrough * Fix typos, grammar, and punctuation errors in `docs/contributing/contributing-releases/README.md` ([link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL30-R30), [link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL40-R40), [link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL63-R55), [link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL75-R75), [link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL96-R90), [link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL105-R97)) * Remove obsolete step of purging CDN cache from release process in `docs/contributing/contributing-releases/README.md` ([link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL47-L54)) Signed-off-by: Yetkin Timocin <ytimocin@microsoft.com> Signed-off-by: ytimocin <ytimocin@microsoft.com> Signed-off-by: willdavsmith <willdavsmith@gmail.com>
willdavsmith
pushed a commit
that referenced
this pull request
Nov 6, 2023
# Description Update release doc. ## Type of change - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional). ## Auto-generated summary <!-- copilot:all --> ### <samp>🤖 Generated by Copilot at 1bc8d01</samp> ### Summary :pencil2::memo::heavy_check_mark: <!-- 1. :pencil2: - This emoji represents the correction of typos, spelling, and grammar errors. For example, line 9 was changed from "This document describes how to contribute to the releases of the project." to "This document describes how to contribute to the project's releases." 2. :memo: - This emoji represents the improvement of formatting, style, and consistency. For example, line 15 was changed from "The project follows the [Semantic Versioning](https://semver.org/) convention for its releases." to "The project follows the [Semantic Versioning](https://semver.org/) (SemVer) convention for its releases." to introduce the acronym for later use. 3. ✔️ - This emoji represents the clarification and enhancement of the information and instructions. For example, line 25 was changed from "The project uses [GitHub milestones](https://docs.github.com/en/github/managing-your-work-on-github/about-milestones) to track the progress and scope of each release." to "The project uses [GitHub milestones](https://docs.github.com/en/github/managing-your-work-on-github/about-milestones) to track the progress and scope of each release. Each milestone corresponds to a specific version number and release date." to provide more details and context. --> Fix documentation errors in `contributing-releases` guide. This improves the readability and accuracy of the guide for contributors and users. > _We are the ones who fix the docs_ > _We purge the errors from the text_ > _We wield the power of the backticks_ > _We make the releases shine and flex_ ### Walkthrough * Fix typos, grammar, and punctuation errors in `docs/contributing/contributing-releases/README.md` ([link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL30-R30), [link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL40-R40), [link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL63-R55), [link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL75-R75), [link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL96-R90), [link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL105-R97)) * Remove obsolete step of purging CDN cache from release process in `docs/contributing/contributing-releases/README.md` ([link](https://github.com/radius-project/radius/pull/6624/files?diff=unified&w=0#diff-4b032acb8e706dca3cf78512aadf53ee8b05354e51cd46023ed550c0625b33fbL47-L54)) Signed-off-by: Yetkin Timocin <ytimocin@microsoft.com> Signed-off-by: ytimocin <ytimocin@microsoft.com> Signed-off-by: willdavsmith <willdavsmith@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Update release doc.
Type of change
Auto-generated summary
🤖 Generated by Copilot at 1bc8d01
Summary
✏️📝✔️
Fix documentation errors in
contributing-releasesguide. This improves the readability and accuracy of the guide for contributors and users.Walkthrough
docs/contributing/contributing-releases/README.md(link, link, link, link, link, link)docs/contributing/contributing-releases/README.md(link)