github/ROCm
1
1
Fork 0
mirror of https://github.com/ROCm/ROCm.git synced 2026-01-09 06:38:00 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
a3a6c17b3d7520205592292a50735af8ef596e02
ROCm/tools/autotag/README.md
Sam Wu a3a6c17b3d Merge roc-6.1.x into docs/6.1.0 (#3055) 
* update manifest file for ROCm6.1 (#3024)

Co-authored-by: Wang, Yanyao <yanyao.wang@amd.com>

* Add ROCm version 6.1.0 to version list (#3023) (#3025)

* Merge develop into roc-6.1.x (#3048)

* Add ROCm version 6.1.0 to version list (#3023)

* Update CHANGELOG.md

Added GitHub links to Changelog

* Update CHANGELOG.md

* Update manifest for ROCm 6.1.0 (#3022)

* Reorganize default.xml by group and alphabetically

* Add rocDecode to default.xml

* Add rocDecode to included names in tag script

* update tag to 6.1.0

---------

Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com>

* Update CHANGELOG.md

Updated ROCm Compiler with fixed issue

* docs(tools/autotag/README.md): Add additional note to avoid duplicating data in changelog template (#3018)

* Bump rocm-docs-core from 0.38.1 to 1.0.0 in /docs/sphinx

Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.38.1 to 1.0.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.38.1...v1.0.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* Use Ubuntu 22.04 and Python 3.10 in RTD config

* Update README.md (#3043)

* Update README.md

Fix rocSPARSE build link

* Update link to just general page, instead of anchor

* Add 'JAX for ROCm' link to index.md (#3034)

* Add JAX for ROCm link to index.md

* Reorder third-party libraries installation guides in index

* Update links to rocAL component (#3033)

* Update links to rocAL component

* Change absolute rocm docs links to relative

* Update compatibility/precision-support links (#3030)

* Change links to component data type support pages from absolute to relative

* Fix rocPRIM data type support links

* Empty commit to trigger demo rebuild.

* Update excluded and included projects

* Separate templates into a module; Fix MIVisionX template

* Add hipfort changelog processor

* Add rpp custom processor

* Add custom processor for rvs

* update the code-owner list (#3046)

* Update default.xml (#3038)

* Remove HIPCC from default.xml

HIPCC moved into llvm-project

* Remove ROCm-Device-Libs from default.xml

ROCm-Device-Libs was moved into llvm-project

* Remove ROCm-CompilerSupport from default.xml

ROCm-CompilerSupport was moved into llvm-project

* Add rocprofiler-register to default.xml

Added in 6.1 manifest

* Apply mathlibs group to projects in manifest

* Bump rocm-docs-core from 0.38.1 to 1.0.0 in /docs/sphinx (#3047)

* Bump rocm-docs-core from 0.38.1 to 1.0.0 in /docs/sphinx

Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.38.1 to 1.0.0.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.38.1...v1.0.0)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* Set Ubuntu 22.04 and Python 3.10 in ReadtheDocs config

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>

* Add 6.1.0.md template

* Add AMD SMI to 6.1.0 template

* Add ROCm Compiler to 6.1.0 template

* Add RDC to 6.1.0 template

* Add ROCgdb to 6.1.0 template

* Add ROCm SMI to 6.1.0 template

* Add ROCProfiler to 6.1.0 template

* Add MI200 SR-IOV known issue to 6.1.0 template

* Add MI300 RAS fixed defect to 6.1.0 template

* docs(6.1.0.md): Add more changelog notes for 6.1.0

* Update 6.1.0.md

Added links to GitHub for known issues and ROCm Compiler fixed defect

* Test autotag script

* Add ck template

* Add HIPIFY to included names for tag script

* Remove rocprofiler from tag_script

* Remove RVS template

Determine cause of missing later

* Add HIPIFY to template for 6.1.0

* Add extra line to topp of template for formatting changelog

* Update 5.7.1.md

Fixing the broken link for rocBLAS programmer's guide in 5.7.1 Changelog.

* Regenerate changelog with new 5.7.1 link fix

* Add note for tag_script included_names

* Improve readability of GPU architecture hardware specs (#3009)

* move units of measurement to table headers

* add glossary explaining table headers

* add missed units and update h1

* toc listing to say indicate Accelerators & GPUs

* fix typo

* update meta description and keywords

* Update title in toc to fit in sidebar

* update title, toc, and filename

* Fix broken link to HIP programming guide

* Revert "update title, toc, and filename"

This reverts commit 6b9e687805.

* Revert glossary; slight fixes

* Change 'Pro' to 'PRO' for consistency

* Add references to programming and hardware architecture guides

* Change 'warp' to 'wavefront'

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Roopa Malavally <56051583+Rmalavally@users.noreply.github.com>
Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: peter <peter.park@amd.com>
Co-authored-by: amitkumar-amd <120512306+amitkumar-amd@users.noreply.github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Yanyao Wang <yanywang@amd.com>
Co-authored-by: Wang, Yanyao <yanyao.wang@amd.com>
Co-authored-by: Roopa Malavally <56051583+Rmalavally@users.noreply.github.com>
Co-authored-by: Young Hui - AMD <145490163+yhuiYH@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: peter <peter.park@amd.com>
Co-authored-by: amitkumar-amd <120512306+amitkumar-amd@users.noreply.github.com>
2024-04-22 14:38:25 -06:00

2.5 KiB
Executable File
Raw Blame History

Autotag

Pre-requisites

  • Python 3.10
  • Create a GitHub Personal Access Token.
    • Tested with all the read-only permissions, but public_repo, read:project read:user, and repo:status should be enough.
    • Copy the token somewhere safe.
  • Configure SSO for this token by authorizing it for the following organizations:
    • ROCm-Developer-Tools
    • RadeonOpenCompute
    • ROCmSoftwarePlatform

Updating the changelog

IMPORTANT: It is key to update the template Markdown files in tools/autotag/templates/rocm_changes (eg: 5.6.0.md) and not the CHANGELOG.md itself to ensure that updates are not overwritten by the autotag script. The template should only have content from changelogs that are not included by the script to avoid duplicating data.

  • Add or update the release specific notes in tools/autotag/templates/rocm_changes
  • Ensure the all the repositories have their release specific branch with the updated changelogs
  • Run this for 5.6.0 (change for whatever version you require)
  • GITHUB_ACCESS_TOKEN=my_token_here

To generate the changelog from 5.0.0 up to and including 6.1.0:

python3 tag_script.py -t $GITHUB_ACCESS_TOKEN --no-release --no-pulls --do-previous --compile_file ../../CHANGELOG.md --branch release/rocm-rel-6.1 6.1.0

To generate the changelog only for 6.1.0:

python3 tag_script.py -t $GITHUB_ACCESS_TOKEN --no-release --no-pulls --compile_file ../../CHANGELOG.md --branch release/rocm-rel-6.1 6.1.0

Notes

If branch cannot be found, edit default.xml at root. Sometimes the script doesn't know whether to include or exclude an entry for a specific release. Continue this part by accepting (Y) or rejecting (N) entries. The end result should be a newly generated changelog in the project root. Compiling the changelog without the --do-previous-flag will always think that all libraries are new since no previous version of said library has been parsed. Trying to run without a token is possible but GitHub enforces stricter rate limits and is therefore not advised.

  • Copy over the first part of the changelog and replace the old release notes in RELEASE.md.

Adding new libraries/repositories

  • Add the name or group of the repository (retrieved in default.xml in the ROCm project root) to: included_names or included_groups to auto_tag.py.
  • At the moment of writing, this is only in the 5.6 branch and not the develop branch.
  • Re-run the command specified in the steps above.
  • Some libraries do not have the changelog for every point release. The tool will give out warnings, but it is okay to ignore them.
Reference in New Issue View Git Blame Copy Permalink