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

Updating release documentation for clarity #7150

Merged

Conversation

willdavsmith
Copy link
Contributor

@willdavsmith willdavsmith commented Feb 7, 2024

Description

  • Updating release process documentation to make it more clear

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).

Closes: #7106

@willdavsmith willdavsmith requested review from a team as code owners February 7, 2024 22:14
vinayada1
vinayada1 previously approved these changes Feb 22, 2024
@radius-functional-tests
Copy link

radius-functional-tests bot commented Feb 23, 2024

Radius functional test overview

🔍 Go to test action run

Name Value
Repository willdavsmith/radius
Commit ref 3e626d1
Unique ID e745ea15da
Image tag pr-e745ea15da
Click here to see the list of tools in the current test run
  • gotestsum 1.10.0
  • KinD: v0.20.0
  • Dapr: 1.12.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.1.0
  • Bicep recipe location ghcr.io/radius-project/dev/test/functional/shared/recipes/<name>:pr-e745ea15da
  • Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
  • applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-e745ea15da
  • controller test image location: ghcr.io/radius-project/dev/controller:pr-e745ea15da
  • ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-e745ea15da
  • deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting msgrp functional tests...
⌛ Starting ucp functional tests...
⌛ Starting datastoresrp functional tests...
⌛ Starting daprrp functional tests...
⌛ Starting kubernetes functional tests...
⌛ Starting samples functional tests...
⌛ Starting shared functional tests...
✅ msgrp functional tests succeeded
✅ samples functional tests succeeded
✅ kubernetes functional tests succeeded
✅ ucp functional tests succeeded
✅ daprrp functional tests succeeded
✅ datastoresrp functional tests succeeded
✅ shared functional tests succeeded

Copy link
Contributor

@kachawla kachawla left a comment

Choose a reason for hiding this comment

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

Could you update the PR title and description to reflect a summary/description of the bug being fixed? Using 'bug from 0.30 release' is too generic and doesn't provide a clear commit message.

docs/contributing/contributing-releases/README.md Outdated Show resolved Hide resolved
docs/contributing/contributing-releases/README.md Outdated Show resolved Hide resolved
docs/contributing/contributing-releases/README.md Outdated Show resolved Hide resolved
docs/contributing/contributing-releases/README.md Outdated Show resolved Hide resolved
docs/contributing/contributing-releases/README.md Outdated Show resolved Hide resolved
docs/contributing/contributing-releases/README.md Outdated Show resolved Hide resolved
@willdavsmith willdavsmith changed the title Updating documentation and fixing bug from 0.30 release Updating release documentation for clarity Feb 26, 2024
@willdavsmith
Copy link
Contributor Author

Could you update the PR title and description to reflect a summary/description of the bug being fixed? Using 'bug from 0.30 release' is too generic and doesn't provide a clear commit message.

Sure, I have updated the PR title and created a new PR for the release bug: #7150

```bash
git push origin <USERNAME>/<BRANCHNAME>
```
Each release belongs to a *channel* named `<major>.<minor>`. Releases will only interact with assets from their channel. For example, the `0.1` `rad` CLI will:
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd suggest moving this section up to the top (in the definitions). The definitions explain a bunch of things, but then the real description of how we use releases is down here.

kachawla
kachawla previously approved these changes Feb 29, 2024
@radius-functional-tests
Copy link

radius-functional-tests bot commented Feb 29, 2024

Radius functional test overview

🔍 Go to test action run

Name Value
Repository willdavsmith/radius
Commit ref 30b8f8c
Unique ID a734f6d05d
Image tag pr-a734f6d05d
Click here to see the list of tools in the current test run
  • gotestsum 1.10.0
  • KinD: v0.20.0
  • Dapr: 1.12.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.1.0
  • Bicep recipe location ghcr.io/radius-project/dev/test/functional/shared/recipes/<name>:pr-a734f6d05d
  • Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
  • applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-a734f6d05d
  • controller test image location: ghcr.io/radius-project/dev/controller:pr-a734f6d05d
  • ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-a734f6d05d
  • deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting ucp functional tests...
⌛ Starting shared functional tests...
⌛ Starting msgrp functional tests...
⌛ Starting daprrp functional tests...
⌛ Starting kubernetes functional tests...
⌛ Starting samples functional tests...
⌛ Starting datastoresrp functional tests...
✅ samples functional tests succeeded
✅ msgrp functional tests succeeded
✅ kubernetes functional tests succeeded
✅ ucp functional tests succeeded
✅ daprrp functional tests succeeded
✅ datastoresrp functional tests succeeded
✅ shared functional tests succeeded

1. Create a PR to merge into the release branch (format: release/x.y) in the radius repo. Cherry-pick the `version.yaml` changes and the release notes from the previous step in this PR. This will ensure that the version changes and release notes are included in the release branch. [Example](https://github.com/radius-project/radius/pull/6114/files)
1. Clone the [radius-project/radius](https://github.com/radius-project/radius) repo locally, or use your existing local copy.
```
git clone [email protected]:radius-project/radius.git
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be a fork rather than the main repo? Are we counting on the release captain to have push permissions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, for now we are counting on the release captain to have push permissions at the moment. This is because we require the GH token to create a comment on the PR. We could definitely change this but for now we should fork directly from the repo.

ref: #6927 (comment)

1. Go through steps 1-4 of "Creating an RC release" above on the `main` branch, substituting the patch release version instead of the final release version. For example, if the final release version number is 0.1.0, the patch release version would be 0.1.1.
1. Clone the [radius-project/bicep](https://github.com/radius-project/bicep) repo locally, or use your existing local copy.
```
git clone [email protected]:radius-project/radius.git
Copy link
Contributor

Choose a reason for hiding this comment

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

Same question, should this be a fork?

rynowak
rynowak previously approved these changes Mar 3, 2024
Copy link
Contributor

@rynowak rynowak left a comment

Choose a reason for hiding this comment

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

:shipit: This is a really big improvement. I had one question about whether the instructions should be talking about forks, or about the main repo. Other than that LGTM

@willdavsmith willdavsmith marked this pull request as draft March 4, 2024 18:14
vinayada1
vinayada1 previously approved these changes Mar 7, 2024
@willdavsmith willdavsmith dismissed stale reviews from vinayada1, rynowak, and kachawla via e2f63c0 March 25, 2024 18:07
Copy link
Contributor

@kachawla kachawla left a comment

Choose a reason for hiding this comment

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

@willdavsmith is this pending on addressing comments or ready for review?

@willdavsmith willdavsmith marked this pull request as ready for review April 8, 2024 19:35
@willdavsmith
Copy link
Contributor Author

@willdavsmith is this pending on addressing comments or ready for review?

ready for review! It was reviewed by @youngbupark during the last release and seems to be correct.

@willdavsmith willdavsmith force-pushed the willdavsmith/0.30-release-fixes branch from e2f63c0 to 954a3d7 Compare April 8, 2024 19:37
Signed-off-by: willdavsmith <[email protected]>
@willdavsmith willdavsmith force-pushed the willdavsmith/0.30-release-fixes branch from 954a3d7 to 9a4c4f1 Compare April 8, 2024 19:42
@radius-functional-tests
Copy link

radius-functional-tests bot commented Apr 8, 2024

Radius functional test overview

🔍 Go to test action run

Name Value
Repository willdavsmith/radius
Commit ref 9a4c4f1
Unique ID funccfba4ce030
Image tag pr-funccfba4ce030
Click here to see the list of tools in the current test run
  • gotestsum 1.10.0
  • KinD: v0.20.0
  • Dapr: 1.12.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.1.0
  • Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-funccfba4ce030
  • Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
  • applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-funccfba4ce030
  • controller test image location: ghcr.io/radius-project/dev/controller:pr-funccfba4ce030
  • ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-funccfba4ce030
  • deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting kubernetes functional tests...
⌛ Starting cli functional tests...
⌛ Starting daprrp functional tests...
⌛ Starting shared functional tests...
⌛ Starting ucp functional tests...
⌛ Starting msgrp functional tests...
⌛ Starting samples functional tests...
⌛ Starting datastoresrp functional tests...
✅ kubernetes functional tests succeeded
✅ msgrp functional tests succeeded
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ daprrp functional tests succeeded
✅ cli functional tests succeeded
✅ datastoresrp functional tests succeeded
✅ shared functional tests succeeded

Copy link

codecov bot commented Apr 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.83%. Comparing base (5970e72) to head (23c6fbe).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7150      +/-   ##
==========================================
- Coverage   63.84%   63.83%   -0.01%     
==========================================
  Files         417      417              
  Lines       23497    23497              
==========================================
- Hits        15001    14999       -2     
- Misses       7227     7228       +1     
- Partials     1269     1270       +1     

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

@kachawla
Copy link
Contributor

@willdavsmith is this pending on addressing comments or ready for review?

ready for review! It was reviewed by @youngbupark during the last release and seems to be correct.

great, thanks! I'll merge it once all the workflows pass.

@kachawla kachawla temporarily deployed to functional-tests April 11, 2024 23:01 — with GitHub Actions Inactive
@radius-functional-tests
Copy link

radius-functional-tests bot commented Apr 11, 2024

Radius functional test overview

🔍 Go to test action run

Name Value
Repository willdavsmith/radius
Commit ref 9682cd1
Unique ID funcb4ccc4495f
Image tag pr-funcb4ccc4495f
Click here to see the list of tools in the current test run
  • gotestsum 1.10.0
  • KinD: v0.20.0
  • Dapr: 1.12.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.1.0
  • Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-funcb4ccc4495f
  • Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
  • applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-funcb4ccc4495f
  • controller test image location: ghcr.io/radius-project/dev/controller:pr-funcb4ccc4495f
  • ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-funcb4ccc4495f
  • deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting shared functional tests...
⌛ Starting cli functional tests...
⌛ Starting kubernetes functional tests...
⌛ Starting samples functional tests...
⌛ Starting ucp functional tests...
⌛ Starting msgrp functional tests...
⌛ Starting daprrp functional tests...
⌛ Starting datastoresrp functional tests...
✅ msgrp functional tests succeeded
✅ samples functional tests succeeded
✅ kubernetes functional tests succeeded
✅ ucp functional tests succeeded
✅ cli functional tests succeeded
✅ daprrp functional tests succeeded
✅ datastoresrp functional tests succeeded
✅ shared functional tests succeeded

@kachawla kachawla temporarily deployed to functional-tests April 11, 2024 23:24 — with GitHub Actions Inactive
@radius-functional-tests
Copy link

radius-functional-tests bot commented Apr 11, 2024

Radius functional test overview

🔍 Go to test action run

Name Value
Repository willdavsmith/radius
Commit ref 23c6fbe
Unique ID func203b8fa44a
Image tag pr-func203b8fa44a
Click here to see the list of tools in the current test run
  • gotestsum 1.10.0
  • KinD: v0.20.0
  • Dapr: 1.12.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.1.0
  • Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func203b8fa44a
  • Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
  • applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func203b8fa44a
  • controller test image location: ghcr.io/radius-project/dev/controller:pr-func203b8fa44a
  • ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func203b8fa44a
  • deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting kubernetes functional tests...
⌛ Starting msgrp functional tests...
⌛ Starting shared functional tests...
⌛ Starting datastoresrp functional tests...
⌛ Starting samples functional tests...
⌛ Starting ucp functional tests...
⌛ Starting daprrp functional tests...
⌛ Starting cli functional tests...
✅ msgrp functional tests succeeded
✅ samples functional tests succeeded
✅ kubernetes functional tests succeeded
✅ ucp functional tests succeeded
✅ datastoresrp functional tests succeeded
✅ daprrp functional tests succeeded
✅ cli functional tests succeeded
✅ shared functional tests succeeded

@kachawla kachawla merged commit d4be47e into radius-project:main Apr 11, 2024
16 checks passed
sk593 pushed a commit that referenced this pull request Apr 15, 2024
# Description

* Updating release process documentation to make it more clear

## Type of change

<!--

Please select **one** of the following options that describes your
change and delete the others. Clearly identifying the type of change you
are making will help us review your PR faster, and is used in authoring
release notes.

If you are making a bug fix or functionality change to Radius and do not
have an associated issue link please create one now.

-->

- 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).

<!--

Please update the following to link the associated issue. This is
required for some kinds of changes (see above).

-->

Closes: #7106

Signed-off-by: willdavsmith <[email protected]>
Co-authored-by: Karishma Chawla <[email protected]>
sk593 added a commit that referenced this pull request Apr 15, 2024
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.

Release notes are not automatically generated for the release
4 participants