Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 2.91 KB

MAINTAINERS.md

File metadata and controls

29 lines (19 loc) · 2.91 KB
Raw

Maintainers Guide to ROCm Compute Profiler

Publishing a release

Before publishing a new ROCm Compute Profiler release, please review this checklist to ensure all prerequisites are met:

  1. Ensure VERSION file is updated to reflect your desired release version.
  2. Sync amd-mainline with amd-staging. A rebase may be required to pull all the desired patches from the development branch to our stable mainline. Click here to begin that process.
  3. Update CHANGES to reflect all major modifications to the codebase since the last release. When modifying CHANGES please ensure formatting is consistent with the rest of the ROCm software stack. See this template for reference.
  4. Confirm all CI tests are passing. You can easily confirm this by peeking the passing status of all GitHub continuous integration tests.
  5. Create a tag from amd-mainline. More information on tagging can be found at Git Docs - Tagging.

Note

Note: A successful tag should trigger the packaging action which will produce a tarball artifact. This artifact needs to be included as an asset in your release. Please find that the packaging action will automatically create a draft release with your tarball attached.

Once you've completed the above checklist, you are ready to publish your release. Please ensure you follow formatting from past ROCm Compute Profiler releases for consistency. Some important aspects of our release formatting include:

  • Date of release is included in "Release Title".
  • Updates are called out in "Release Description". Updates should mirror those listed in CHANGES.
  • Links to documentation and associated release tarball are called out in "Release Description".
  • The tarball artifact from the corresponding tag is added to "Release Assets".

Publishing a release for ROCm

If you are preparing for a new ROCm release, note that the rocm-ci bot managed by DevOps will be triggering a tag automatically. This tag will follow the format rocm-X.X.X.

Traditionally, we will bump the ROCm Compute Profiler VERSION with a new ROCm release. When we bump the version and reach the prerequisite step (5) above, try tagging with vX.X.X to validate the release tarball generated by the packaging action.

In addition to the prerequisites mentioned above, please make sure that all changes have been merged from amd-staging -> release/rocm-rel-X.X.X to ensure that the "rocm-ci" bot will capture all your changes. It is easiest to file a single pull request ahead of the ROCm release.