Files
ROCm/tools/autotag/README.md
Sam Wu ad66256e52 Merge develop into roc-6.0.x (#2810)
* Create issue_retrieval.yml

I am tasked with adding a GitHub action to process incoming GitHub issues. The AMD GitHub admin team asked me to try out one of their runners and to do so, I need to load in a workflow file.

* changed group to ROCM-Ubuntu

* Added a field to specify project number

This action receives an org name and project number and adds issues to it using this information

* Update issue_retrieval.yml

* Update issue_retrieval.yml

* Generate release notes for 6.0.1 from autotag script (#2790)

* Update CONTRIBUTING.md (#2791)

* Update CONTRIBUTING.md

* Fixed link to licensing document

Also, changed to use relative links for internal files.

* Revert "Update CONTRIBUTING.md" (#2795)

* Text change to direct PRs into default branch, since not all repos have develop branch

* add keywords (#2799)

* Update issue_retrieval.yml

* ci(default.xml): Add hipBLASLt to manifest (#2796)

* Deleting issue_report.yml in favor of a global issue template placed in ROCm/.github (#2803)

* Delete .github/ISSUE_TEMPLATE/issue_report.yml

* Delete .github/ISSUE_TEMPLATE/config.yml

* Delete .github/ISSUE_TEMPLATE directory (#2805)

* docs(conf.py): Update article info for release page (#2806)

* docs(conf.py): Update article info for release page

* Update conf.py

* Fix typo (#2809)

---------

Co-authored-by: abhimeda <138710508+abhimeda@users.noreply.github.com>
Co-authored-by: David Galiffi <dgaliffi@amd.com>
Co-authored-by: Lisa <lisa.delaney@amd.com>
Co-authored-by: Young Hui <young.hui@amd.com>
Co-authored-by: yhuiYH <145490163+yhuiYH@users.noreply.github.com>
2024-01-16 10:53:28 -07:00

2.2 KiB
Executable File

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

  • 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.0.1:

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

To generate the changelog only for 6.0.1:

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

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.