Skip to content

Commit fa51b3d

Browse files
fabiobaltiericarlescufi
authored andcommitted
doc: release process: only use the overview for the release page
Change the release process documentation to only use the overview of the release notes for GitHub releases rather than the full file. The current instructions of copying the full content are broken (the file does not fit anyway and the formatting is incompatible) and result in a cluttered page anyway (the UI is not really meant for long release notes). Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
1 parent 916e04e commit fa51b3d

File tree

2 files changed

+5
-8
lines changed

2 files changed

+5
-8
lines changed

.github/workflows/release.yml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,9 @@ jobs:
2929
name: zephyr-${{ steps.get_version.outputs.VERSION }}.spdx
3030
path: zephyr-${{ steps.get_version.outputs.VERSION }}.spdx
3131

32-
- name: Get Diff since last tag
32+
- name: Create empty release notes body
3333
run: |
34-
oldtag=$(git describe --abbrev=0 ${{ github.ref }}^)
35-
echo "Changes since ${oldtag}:" > release-notes.txt
36-
echo "" >> release-notes.txt
37-
echo "" >> release-notes.txt
38-
git shortlog ${oldtag}..${{ github.ref }} >> release-notes.txt
34+
echo "TODO: add release overview and notes link" > release-notes.txt
3935
4036
- name: Create Release
4137
id: create_release

doc/project/release_process.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -430,8 +430,9 @@ steps:
430430
and edit the release with the ``Edit tag`` button with the following:
431431

432432
* Name it ``Zephyr 1.11.0``
433-
* Copy the full content of ``docs/releases/release-notes-1.11.rst``
434-
into the release notes textbox
433+
* Copy the overview of ``docs/releases/release-notes-1.11.rst``
434+
into the release notes textbox and link to the full release notes
435+
file on docs.zephyrproject.org.
435436

436437
#. Send an email to the mailing lists (``announce`` and ``devel``) with a link
437438
to the release

0 commit comments

Comments
 (0)