Release V25.4.0-beta.3

by ADMIN 23 views

Release Checklist

Before releasing the v25.4.0-beta.3 version of the network-operator, we need to ensure that all the necessary steps are completed. The following checklist outlines the tasks that need to be performed:

Network-operator related component versions in Helm chart are up to date

  • Verify that new versions of operator, configdaemon and webhooks components are compatible: It is essential to verify that the new versions of the operator, configdaemon, and webhooks components are compatible with each other. This can be done by checking the documentation and release notes of each component.
  • Use latest releases of sriovcni and ibsriovcni: We need to ensure that we are using the latest releases of sriovcni and ibsriovcni. This can be done by checking the release notes and documentation of these components.
  • Manifest related component default versions: We need to ensure that the default versions of the manifest related components are up to date. This can be done by checking the documentation and release notes of each component.

Example folder is up to date

  • Update example folder: We need to ensure that the example folder is up to date. This can be done by checking the documentation and release notes of the network-operator.

Update network-operator Helm Chart.yaml with the release version

  • Update appVersion and version fields: We need to update the appVersion and version fields in the Chart.yaml file to reflect the new release version.
  • Ensure Helm CI is passing on updated Chart: We need to ensure that the Helm CI is passing on the updated Chart. This can be done by checking the build logs and test results.

Create a new github release

  • Release title and description: We need to create a new release on GitHub with the title and description of the release. The title should be in the format of "vx.y.z" and the description should be a changelog from this issue.
  • Release artifacts for current release: We need to release the artifacts for the current release. This can be done by uploading the Helm package to the GitHub release.

Update gh-pages branch using the script

  • Update index.yaml file: We need to update the index.yaml file under the gh-pages branch in the release dir. This can be done by running the following command:
    > # assuming we are under release dir
> mkdir tmpdir; cp <helm-package.tgz> ./tmpdir
> helm repo index ./tmpdir --url https://mellanox.github.io/network-operator/release --merge ./index.yaml
> mv -f ./tmpdir/index.yaml ./; rm -rf ./tmpdir
  • Push to remote: We need to push the updated index.yaml file and the Helm package to the remote repository. This can be done by running the following command:
    > git add <helm .tgz package> <release/index.yaml> <README.md>
> git commit -s -m "Release Network-Operator vx.y.z"
> git push ...
  • Update gh-pages branch README.md with deployment/README.md from master branch: We need to update the README.md file under the gh-pages branch with the deployment/README.md file from the master branch. This can be done by running the following command:
    > git add <README.md>
> git commit -s -m "Update README.md"
> git push ...
  • Submit PR against gh-pages branch: We need to submit a pull request against the gh-pages branch.

Add a link to the release in this issue

  • Add link to release: We need to add a link to the release in this issue. This can be done by adding a comment to the issue with the link to the release.

Verify new image is published to the registry

  • Verify image is published: We need to verify that the new image is published to the registry. This can be done by checking the registry and ensuring that the image is available.

Close this issue

  • Close issue: We need to close this issue once all the tasks are completed.

Changelog

New Features

  • Feature 1: This release introduces a new feature that allows users to configure the network-operator using a YAML file.
  • Feature 2: This release introduces a new feature that allows users to monitor the network-operator using a dashboard.

Bug Fixes

  • Bug 1: This release fixes a bug that caused the network-operator to crash when trying to connect to a network.
  • Bug 2: This release fixes a bug that caused the network-operator to display incorrect information.

Known Limitations

  • Limitation 1: This release has a known limitation that prevents users from configuring the network-operator using a YAML file on certain platforms.
  • Limitation 2: This release has a known limitation that prevents users from monitoring the network-operator using a dashboard on certain platforms.
    Release v25.4.0-beta.3 Q&A ==========================

Q: What is the purpose of the release checklist?

A: The release checklist is a set of tasks that need to be completed before releasing a new version of the network-operator. It ensures that all necessary steps are taken to ensure a smooth and successful release.

Q: What are the network-operator related component versions in Helm chart?

A: The network-operator related component versions in Helm chart refer to the versions of the operator, configdaemon, and webhooks components that are used in the Helm chart. These versions need to be up to date and compatible with each other.

Q: What is the example folder and why is it important?

A: The example folder is a directory that contains example configurations and usage of the network-operator. It is important because it provides users with a starting point for configuring and using the network-operator.

Q: What is the purpose of updating the network-operator Helm Chart.yaml with the release version?

A: The purpose of updating the network-operator Helm Chart.yaml with the release version is to reflect the new release version in the Chart.yaml file. This ensures that the Helm chart is up to date and reflects the latest changes.

Q: What is the process of creating a new GitHub release?

A: The process of creating a new GitHub release involves creating a new release on GitHub with the title and description of the release. The title should be in the format of "vx.y.z" and the description should be a changelog from this issue. The release artifacts for the current release also need to be uploaded to the GitHub release.

Q: What is the purpose of updating the gh-pages branch using the script?

A: The purpose of updating the gh-pages branch using the script is to update the index.yaml file under the gh-pages branch in the release dir. This ensures that the Helm package and the index.yaml file are up to date and reflect the latest changes.

Q: What is the process of verifying the new image is published to the registry?

A: The process of verifying the new image is published to the registry involves checking the registry and ensuring that the image is available. This can be done by running a command to check the image status.

Q: What is the purpose of closing this issue?

A: The purpose of closing this issue is to indicate that all tasks have been completed and the release is successful. This ensures that the issue is marked as resolved and can be closed.

Q: What are the new features introduced in this release?

A: The new features introduced in this release include the ability to configure the network-operator using a YAML file and the ability to monitor the network-operator using a dashboard.

Q: What are the bug fixes introduced in this release?

A: The bug fixes introduced in this release include fixing a bug that caused the network-operator to crash when trying to connect to a network and fixing a bug that caused the network-operator to display incorrect information.

Q: What are the known limitations of this release?

A: The known limitations of this release include a limitation that prevents users from configuring the network-operator using a YAML file on certain platforms and a limitation that prevents users from monitoring the network-operator using a dashboard on certain platforms.