Docs: final release notes for v3.1.0 #46271
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mbolivar-nordic
requested review from
MaureenHelm,
carlescufi,
danieldegrasse and
dleach02
github-actions
bot
added
area: Documentation
Release Notes
mbolivar-nordic
force-pushed
the
doc-3.1-final-release-notes
branch
from
d9b9da7 to
382268d
Compare
|
We could use someone with superpowers to override the compliance failures. Those are copied straight from the github issue titles themselves. |
mbolivar-nordic
force-pushed
the
doc-3.1-final-release-notes
branch
from
382268d to
045ab82
Compare
MaureenHelm
previously approved these changes
Jun 3, 2022
Follow along with the release checklist (zephyrproject-rtos#43286) like this: $ ./scripts/release/list_issues.py -o zephyrproject-rtos -r zephyr -s 2022-02-22 -f issues.txt Then copy issues.txt into the right place in the doc, and clean up the resulting .rst errors by properly escaping and converting the markdown format used in github issue titles. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This prints the contents of a zephyr-bugs-$DATE.pickle file in a format similar to the output of list_issues.py. It will be useful to have this in tree so that we can better record the known issues at the time of a particular zephyr release. The pickle file itself should be created using the bug snapshot workflow defined in .github/workflows/bug_snapshot.yaml, which can be triggered manually from this URL: https://github.com/zephyrproject-rtos/zephyr/actions/workflows/bug_snapshot.yaml Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
Every release notes page includes a section for known issues. In previous releases, we have linked to a GitHub query which displays open issues. The problem with this approach is that the information immediately goes stale, making this section's content less than useful. We can do better now that we have a bug snapshot workflow and a script capable of dumping snapshot contents in the same almost-rst-format used by list_issues.py. Use it as follows to archive the known open bugs at time of release: $ wget https://builds.zephyrproject.io/zephyr/bug-snapshot/zephyr-bugs-2022-06-03.pickle.xz $ unxz zephyr-bugs-2022-06-03.pickle.xz $ ./scripts/dump_bugs_pickle.py zephyr-bugs-2022-06-03.pickle Then copy paste the output into the release notes and handle .rst escapes in the same way has previously been done for closed issues since the last release. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
mbolivar-nordic
force-pushed
the
doc-3.1-final-release-notes
branch
from
045ab82 to
44cb9ec
Compare
dkalowsk
previously approved these changes
Jun 3, 2022
|
@dkalowsk feedback addressed, thank you. |
dkalowsk
previously approved these changes
Jun 3, 2022
Make a pass through the file, trying to fix as many issues as possible with how the notes are written. This includes fixes for tense and invalid .rst role usage, as well as removal of any sections which have missing content. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This needs to be in the "API changes" section, instead of in a "Bluetooth" section where it currently is. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
For some reason, there are two different sections covering bluetooth. This is clearly incorrect; fix it by moving the content into a single section. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
There are three lists of issues in the release notes: - security vulnerabilities which received CVEs - other open bugs - resolved issues (Here, "issue" is a strictly more general term than "bug": every bug is an issue, not every issue is a bug. This is GitHub-specific jargon.) The current structure is awkward. Clean it up by unifying the lists under a single top level section and cleaning up the distinction between issues and bugs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
Apply suggestions from Dan Kalowsky to clean up extraneous issues included in the script's output. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
Remove that from the title. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
mbolivar-nordic
force-pushed
the
doc-3.1-final-release-notes
branch
from
2d0f9e2 to
511ce0a
Compare
|
Fixed a doc build error; not sure why I didn't notice that in my local builds. |
52 tasks
dkalowsk
approved these changes
Jun 3, 2022
Merged
MaureenHelm
approved these changes
Jun 4, 2022
35 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request finalizes the release notes page.
There are still a few more documentation related tasks left to do before the release. These will be deferred to a subsequent PR.