Add new sections for changelog template (#103)

RELEASE.md

@@ -21,69 +21,7 @@ ROCm 6.1.2 includes enhancements to SMI tools and improvements to some libraries
 
 ### OS support
 
-ROCm 6.1.2 has been tested against a pre-release version of Ubuntu 22.04.5 (kernel: 5.15 [GA], 6.8 [HWE]).
-
-### AMD SMI
-
-AMD SMI for ROCm 6.1.2
-
-#### Additions
-
-* Added process isolation and clean shader APIs and CLI commands.
-  * `amdsmi_get_gpu_process_isolation()`
-  * `amdsmi_set_gpu_process_isolation()`
-  * `amdsmi_set_gpu_clear_sram_data()`
-* Added the `MIN_POWER` metric to output provided by `amd-smi static --limit`.
-
-#### Optimizations
-
-* Updated the `amd-smi monitor --pcie` output to prevent delays with the `monitor` command.
-
-#### Changes
-
-* Updated `amismi_get_power_cap_info` to return values in uW instead of W.
-* Updated Python library return types for `amdsmi_get_gpu_memory_reserved_pages` and `amdsmi_get_gpu_bad_page_info`.
-* Updated the output of `amd-smi metric --ecc-blocks` to show counters available from blocks.
-
-#### Fixes
-
-* `amdsmi_get_gpu_board_info()` no longer returns junk character strings.
-* `amd-smi metric --power` now correctly details power output for RDNA3, RDNA2, and MI1x devices.
-* Fixed the `amdsmitstReadWrite.TestPowerCapReadWrite` test for RDNA3, RDNA2, and MI100 devices.
-* Fixed an issue with the `amdsmi_get_gpu_memory_reserved_pages` and `amdsmi_get_gpu_bad_page_info` Python interface calls.
-
-#### Removals
-
-* Removed the `amdsmi_get_gpu_process_info` API from the Python library. It was removed from the C library in an earlier release.
-
-```{note}
-See the AMD SMI [detailed changelog](https://github.com/ROCm/amdsmi/blob/rocm-6.1.x/CHANGELOG.md) with code samples for more information.
-```
-
-### HIPCC
-
-HIPCC for ROCm 6.1.2
-
-#### Changes
-
-* **Upcoming:** a future release will enable use of compiled binaries `hipcc.bin` and `hipconfig.bin` by default. No action is needed by users; you may continue calling high-level Perl scripts `hipcc` and `hipconfig`. `hipcc.bin` and `hipconfig.bin` will be invoked by the high-level Perl scripts. To revert to the previous behavior and invoke `hipcc.pl` and `hipconfig.pl`, set the `HIP_USE_PERL_SCRIPTS` environment variable to `1`.
-* **Upcoming:** a subsequent release will remove high-level Perl scripts `hipcc` and `hipconfig`. This release will remove the `HIP_USE_PERL_SCRIPTS` environment variable. It will rename `hipcc.bin` and `hipconfig.bin` to `hipcc` and `hipconfig` respectively. No action is needed by the users. To revert to the previous behavior, invoke `hipcc.pl` and `hipconfig.pl` explicitly.
-* **Upcoming:** a subsequent release will remove `hipcc.pl` and `hipconfig.pl`.
-
-### ROCm SMI
-
-ROCm SMI for ROCm 6.1.2
-
-#### Additions
-
-* Added the ring hang event to the `amdsmi_evt_notification_type_t` enum.
-
-#### Fixes
-
-* Fixed an issue causing ROCm SMI to incorrectly report GPU utilization for RDNA3 GPUs. See the issue on [GitHub](https://github.com/ROCm/ROCm/issues/3112).
-* Fixed the parsing of `pp_od_clk_voltage` in `get_od_clk_volt_info` to work better with MI-series hardware.
-
-### Library changes in ROCm 6.1.2
+ROCm 6.1.2 has been tested against a pre-release version of Ubuntu 22.04.5 (kernel: 5.15 [GA], 6.8 [HWE]).### Library changes in ROCm 6.1.2
 
 | Category | Group | Name | Version | Repository |
 |----------|-------|------|---------|------------|
@@ -679,3 +617,65 @@ Tensile 4.40.0 for ROCm 6.1.2
 - mismatch issue with LdsPad + LdsBlockSizePerPad!=0 and SplitLds
 - incorrect reject condition check for DirectToLds + LdsBlockSizePerPad=-1 case
 - small fix for LdsPad optimization (LdsElement calculation)
+
+### AMD SMI
+
+AMD SMI for ROCm 6.1.2
+
+#### Additions
+
+* Added process isolation and clean shader APIs and CLI commands.
+  * `amdsmi_get_gpu_process_isolation()`
+  * `amdsmi_set_gpu_process_isolation()`
+  * `amdsmi_set_gpu_clear_sram_data()`
+* Added the `MIN_POWER` metric to output provided by `amd-smi static --limit`.
+
+#### Optimizations
+
+* Updated the `amd-smi monitor --pcie` output to prevent delays with the `monitor` command.
+
+#### Changes
+
+* Updated `amismi_get_power_cap_info` to return values in uW instead of W.
+* Updated Python library return types for `amdsmi_get_gpu_memory_reserved_pages` and `amdsmi_get_gpu_bad_page_info`.
+* Updated the output of `amd-smi metric --ecc-blocks` to show counters available from blocks.
+
+#### Fixes
+
+* `amdsmi_get_gpu_board_info()` no longer returns junk character strings.
+* `amd-smi metric --power` now correctly details power output for RDNA3, RDNA2, and MI1x devices.
+* Fixed the `amdsmitstReadWrite.TestPowerCapReadWrite` test for RDNA3, RDNA2, and MI100 devices.
+* Fixed an issue with the `amdsmi_get_gpu_memory_reserved_pages` and `amdsmi_get_gpu_bad_page_info` Python interface calls.
+
+#### Removals
+
+* Removed the `amdsmi_get_gpu_process_info` API from the Python library. It was removed from the C library in an earlier release.
+
+```{note}
+See the AMD SMI [detailed changelog](https://github.com/ROCm/amdsmi/blob/rocm-6.1.x/CHANGELOG.md) with code samples for more information.
+```
+
+### ROCm SMI
+
+ROCm SMI for ROCm 6.1.2
+
+#### Additions
+
+* Added the ring hang event to the `amdsmi_evt_notification_type_t` enum.
+
+#### Fixes
+
+* Fixed an issue causing ROCm SMI to incorrectly report GPU utilization for RDNA3 GPUs. See the issue on [GitHub](https://github.com/ROCm/ROCm/issues/3112).
+* Fixed the parsing of `pp_od_clk_voltage` in `get_od_clk_volt_info` to work better with MI-series hardware.
+
+
+
+### HIPCC
+
+HIPCC for ROCm 6.1.2
+
+#### Changes
+
+* **Upcoming:** a future release will enable use of compiled binaries `hipcc.bin` and `hipconfig.bin` by default. No action is needed by users; you may continue calling high-level Perl scripts `hipcc` and `hipconfig`. `hipcc.bin` and `hipconfig.bin` will be invoked by the high-level Perl scripts. To revert to the previous behavior and invoke `hipcc.pl` and `hipconfig.pl`, set the `HIP_USE_PERL_SCRIPTS` environment variable to `1`.
+* **Upcoming:** a subsequent release will remove high-level Perl scripts `hipcc` and `hipconfig`. This release will remove the `HIP_USE_PERL_SCRIPTS` environment variable. It will rename `hipcc.bin` and `hipconfig.bin` to `hipcc` and `hipconfig` respectively. No action is needed by the users. To revert to the previous behavior, invoke `hipcc.pl` and `hipconfig.pl` explicitly.
+* **Upcoming:** a subsequent release will remove `hipcc.pl` and `hipconfig.pl`.

tools/autotag/README.md

@@ -13,9 +13,9 @@
 
 ## Updating the changelog and release notes
 
-> 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` or `RELEASE.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.
+> IMPORTANT: It is key to update the template Markdown files in `tools/autotag/templates/<name of change type>` (eg: `5.6.0.md`) and not the `CHANGELOG.md` or `RELEASE.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`
+* Add or update the release specific notes in `tools/autotag/templates/<name of change type>`
 * 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`

tools/autotag/templates/changelog.jinja

@@ -23,9 +23,12 @@ This page contains the release notes for AMD ROCm™ Software.
 -------------------
 
 ## ROCm {{version}}
-
-{%- set rocm_changes = "./rocm_changes/" ~ version ~ ".md" %}
-{% include rocm_changes ignore missing %}
+{{- "\n\n" -}}
+{%- set highlights = "./highlights/" ~ version ~ ".md" %}
+{%- include highlights ignore missing -%}
+{{- "\n\n" -}}
+{%- set support = "./support/" ~ version ~ ".md" %}
+{%- include support ignore missing -%}
 
 ### Library changes in ROCm {{version}}
 
@@ -54,7 +57,17 @@ This page contains the release notes for AMD ROCm™ Software.
 {{change|trim|e}}
 
 {%- endfor %}{# change in lib.data.changes #}
-{%- endif  %}
+{%- endif -%}
 {%- endfor %}{# lib in release.libraries #}
+{{- "\n\n" -}}
+{%- set extra_components = "./extra_components/" ~ version ~ ".md" %}
+{%- include extra_components ignore missing -%}
+{{- "\n\n" -}}
+{%- set known_issues = "./known_issues/" ~ version ~ ".md" %}
+{%- include known_issues ignore missing -%}
+{{- "\n\n" -}}
+{%- set upcoming_changes = "./upcoming_changes/" ~ version ~ ".md" %}
+{%- include upcoming_changes ignore missing -%}
+
 {%- endfor %}{# release in releases #}
 {# EOF #}

tools/autotag/templates/extra_components/6.1.2.md

@@ -1,10 +1,3 @@
-
-ROCm 6.1.2 includes enhancements to SMI tools and improvements to some libraries.
-
-### OS support
-
-ROCm 6.1.2 has been tested against a pre-release version of Ubuntu 22.04.5 (kernel: 5.15 [GA], 6.8 [HWE]).
-
 ### AMD SMI
 
 AMD SMI for ROCm 6.1.2
@@ -42,16 +35,6 @@ AMD SMI for ROCm 6.1.2
 See the AMD SMI [detailed changelog](https://github.com/ROCm/amdsmi/blob/rocm-6.1.x/CHANGELOG.md) with code samples for more information.
 ```
 
-### HIPCC
-
-HIPCC for ROCm 6.1.2
-
-#### Changes
-
-* **Upcoming:** a future release will enable use of compiled binaries `hipcc.bin` and `hipconfig.bin` by default. No action is needed by users; you may continue calling high-level Perl scripts `hipcc` and `hipconfig`. `hipcc.bin` and `hipconfig.bin` will be invoked by the high-level Perl scripts. To revert to the previous behavior and invoke `hipcc.pl` and `hipconfig.pl`, set the `HIP_USE_PERL_SCRIPTS` environment variable to `1`.
-* **Upcoming:** a subsequent release will remove high-level Perl scripts `hipcc` and `hipconfig`. This release will remove the `HIP_USE_PERL_SCRIPTS` environment variable. It will rename `hipcc.bin` and `hipconfig.bin` to `hipcc` and `hipconfig` respectively. No action is needed by the users. To revert to the previous behavior, invoke `hipcc.pl` and `hipconfig.pl` explicitly.
-* **Upcoming:** a subsequent release will remove `hipcc.pl` and `hipconfig.pl`.
-
 ### ROCm SMI
 
 ROCm SMI for ROCm 6.1.2

tools/autotag/templates/highlights/6.1.2.md

@@ -0,0 +1 @@
+ROCm 6.1.2 includes enhancements to SMI tools and improvements to some libraries.

tools/autotag/templates/support/6.1.2.md

@@ -0,0 +1,3 @@
+### OS support
+
+ROCm 6.1.2 has been tested against a pre-release version of Ubuntu 22.04.5 (kernel: 5.15 [GA], 6.8 [HWE]).

tools/autotag/templates/upcoming_changes/6.1.2.md

@@ -0,0 +1,9 @@
+### HIPCC
+
+HIPCC for ROCm 6.1.2
+
+#### Changes
+
+* **Upcoming:** a future release will enable use of compiled binaries `hipcc.bin` and `hipconfig.bin` by default. No action is needed by users; you may continue calling high-level Perl scripts `hipcc` and `hipconfig`. `hipcc.bin` and `hipconfig.bin` will be invoked by the high-level Perl scripts. To revert to the previous behavior and invoke `hipcc.pl` and `hipconfig.pl`, set the `HIP_USE_PERL_SCRIPTS` environment variable to `1`.
+* **Upcoming:** a subsequent release will remove high-level Perl scripts `hipcc` and `hipconfig`. This release will remove the `HIP_USE_PERL_SCRIPTS` environment variable. It will rename `hipcc.bin` and `hipconfig.bin` to `hipcc` and `hipconfig` respectively. No action is needed by the users. To revert to the previous behavior, invoke `hipcc.pl` and `hipconfig.pl` explicitly.
+* **Upcoming:** a subsequent release will remove `hipcc.pl` and `hipconfig.pl`.