Commit Graph

18 Commits

Author SHA1 Message Date
Fabio Baltieri
5155c0e820 doc: release: add a step to verify that the tag is signed
Add an extra "git show" step to the release process to verify that the
key has been indeed signed.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2024-11-06 18:52:51 -08:00
Benjamin Cabé
df294e34e1 doc: sphinx-lint: fix bad usage of "default role"
Fixes bad usage of single backticks in lieu of double backticks for
rendering inline literals, or simple '*' for italics.

When appropriate, a better construct than double backticks has been
selected (ex. :file:, :kconfig:option:, :c:func:, ...), or proper :ref:
have been used if the original intention was to have a link.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 11:42:51 -05:00
Anas Nashif
10c9037ff1 doc: release: allow tests after RC1
After RC1 (feature freeze), new tests for existing features are allowed.
Afterwards, only bug fixes and documentation to existing tests are
allowed.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-06-27 15:15:43 -04:00
Anas Nashif
ef5bb33f7b doc: Update release criteria
Update release criteria based on previous discussions and agreements
reached.
- remove bug count at critria
- Add platform tiers
- Define criteria
- Clarify block bugs

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-06-27 15:15:43 -04:00
Anas Nashif
1706879fbd doc: release: clarify changes allowed during stabilization
Clarificatin on feature freeze and exceptions.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-06-27 15:15:43 -04:00
Flavio Ceolin
dd58f80fe2 doc: Static Analysis requirement
Sets static analysis  an indispensable requirement for our project
releases.

Static analysis is not merely a tool but a proactive
strategy to unearth and address potential issues in the early stages
of development, long before they mature into critical
vulnerabilities. By scrutinizing code at rest, static analysis unveils
latent defects and potential security risks, thus bolstering the
resilience of our software against future threats.

Fixes: #64591

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-01-02 10:09:14 +01:00
Hein Wessels
8219c7ccda doc: release process: link to milestone dates on wiki
This adds a link for convenience. Many times before I struggled to
find the date for the next feature freeze. This is to help others,
and myself, to find it easier in the future.

Signed-off-by: Hein Wessels <heinwessels93@gmail.com>
2023-09-18 11:16:27 +01:00
Fabio Baltieri
ecf29a77f8 doc: release: drop the notes about listing github issues
Drop the notes about listing all the github issues with the release
notes. That was a huge list of github issues sorted by closing time,
very noisy and hard to maintain.

The unfiltered list of changes is already in the commit history, a
distilled list is now in the blog posts and a final list is in the notes
summary.

The issue list has been skipped in 3.4 already, let's just drop it from
the process.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-07-25 16:45:15 +02:00
Anas Nashif
6f1c764a92 doc: release: minor tweaks
Minor tweak about length of stabilization phase and the merge process.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-05-23 10:43:21 -04:00
Anas Nashif
8c410123b3 doc: releases: expand on release cycle and support
Add more information about release cycle and type of releases we have.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-05-23 10:43:21 -04:00
Fabio Baltieri
35ec706d82 doc: release process: drop the comment about changing the release name
Now that the automation picks the right name automatically, there's no
need to edit it manually as part of the release process.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-10-24 11:17:00 -04:00
Fabio Baltieri
34f74c96b0 ci: release: stop creating releases for RC tags
RC releases clutter the release page, there's no reason for keeping them
after the release is done, filter them out from the workflow so they
don't get created in the first place..

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-10-10 07:25:15 -07:00
Fabio Baltieri
0da3b69b50 doc: release process: stop creating zephyr- prefixed tags
Drop the process step to create zephyr- prefixed tags.

This has been done so that autogenerated release files have a sensible
name, but GitHub started to automatically prefix the project names to
release artifacts anyway using HTTP headers, which now results in file
named like: zephyr-zephyr-v3.2.0.tar.gz, so the extra tags are now
causing the opposite problem.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-10-07 13:07:14 +00:00
Fabio Baltieri
fa51b3db1c 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>
2022-10-07 14:32:42 +02:00
Anas Nashif
80f6a3adbc doc: release process: update milestone definition
Update milestone definitions to reflect current state of the release
process.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-19 12:26:38 -04:00
Anas Nashif
92c285e038 doc: releases: remove moderation levels
Remove obsolete information about moderation.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-19 12:26:38 -04:00
Anas Nashif
c2f1b8db7b doc: releases: replace merge window terminology
Do not use the merge window terminology which can be confusing and use
"development phase" and "stabilisation phase" instead.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-19 12:26:38 -04:00
Anas Nashif
5b3b9c7c41 doc: create new section for project structure
Move all project and governance related docs into one new section.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00