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>
This commit is contained in:
Fabio Baltieri 2022-10-03 10:29:40 +00:00 committed by Carles Cufí
parent 916e04e0ef
commit fa51b3db1c
2 changed files with 5 additions and 8 deletions

View file

@ -29,13 +29,9 @@ jobs:
name: zephyr-${{ steps.get_version.outputs.VERSION }}.spdx
path: zephyr-${{ steps.get_version.outputs.VERSION }}.spdx
- name: Get Diff since last tag
- name: Create empty release notes body
run: |
oldtag=$(git describe --abbrev=0 ${{ github.ref }}^)
echo "Changes since ${oldtag}:" > release-notes.txt
echo "" >> release-notes.txt
echo "" >> release-notes.txt
git shortlog ${oldtag}..${{ github.ref }} >> release-notes.txt
echo "TODO: add release overview and notes link" > release-notes.txt
- name: Create Release
id: create_release

View file

@ -430,8 +430,9 @@ steps:
and edit the release with the ``Edit tag`` button with the following:
* Name it ``Zephyr 1.11.0``
* Copy the full content of ``docs/releases/release-notes-1.11.rst``
into the release notes textbox
* Copy the overview of ``docs/releases/release-notes-1.11.rst``
into the release notes textbox and link to the full release notes
file on docs.zephyrproject.org.
#. Send an email to the mailing lists (``announce`` and ``devel``) with a link
to the release