Cole Ramos
aae2e356ea
* Update contributing guide for new default branch
Signed-off-by: coleramos425 <colramos@amd.com>
* Add develop target to related workflows
Signed-off-by: coleramos425 <colramos@amd.com>
* Auto sync develop and staging
Signed-off-by: coleramos425 <colramos@amd.com>
* Run sync every night at 12AM
Signed-off-by: coleramos425 <colramos@amd.com>
* Rename sync workflow
Signed-off-by: coleramos425 <colramos@amd.com>
* Update maintainers guide
Signed-off-by: coleramos425 <colramos@amd.com>
* Update readme
Signed-off-by: coleramos425 <colramos@amd.com>
* Auto accept PRs for daily branch sync
Signed-off-by: coleramos425 <colramos@amd.com>
* Direct merge. No PR for merge required
Signed-off-by: coleramos425 <colramos@amd.com>
---------
Signed-off-by: coleramos425 <colramos@amd.com>
[ROCm/rocprofiler-compute commit: 0a52e6f19d]
30 строки
2.8 KiB
Markdown
30 строки
2.8 KiB
Markdown
# 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](VERSION) file is updated** to reflect your desired release version.
|
|
2) **Sync `amd-mainline` with `amd-staging`**. Unless major changes were introduced, you should be able to merge using the fast-forward only strategy.
|
|
3) **Update [CHANGES](CHANGES)** to reflect all major modifications to the codebase since the last release. When modifying [CHANGES](CHANGES) please ensure formatting is consistent with the rest of the ROCm software stack. See [this template](https://github.com/ROCm/hipTensor/blob/develop/CHANGELOG.md) 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](https://git-scm.com/book/en/v2/Git-Basics-Tagging).
|
|
|
|
> [!NOTE]
|
|
Note: A successful tag should trigger the [packaging action](.github/workflows/packaging.yml) which will produce a tarball artifact. **This artifact needs to be included as an asset in your release**. The [packaging action](.github/workflows/packaging.yml) will automatically upload the artifact and generate release notes to the corresponding tag.
|
|
|
|
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](https://github.com/ROCm/rocprofiler-compute/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](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](https://github.com/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](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](.github/workflows/packaging.yml).
|
|
|
|
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.
|