You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: release-notes.d/README
+30-13
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,8 @@
1
1
# Fedora CoreOS Release Note
2
2
3
-
This directory stores the Fedora CoreOS release note yaml snippets which will be picked up by
4
-
`fedora-coreos-releng-automation/coreos-release-note-generator` [1] script to produce the final
5
-
`release-notes.yaml` for a release. After `release-notes.yaml` has been generated / updated,
6
-
all snippets under `release-notes.d` are expected to be cleaned up for future release notes.
3
+
This directory stores the Fedora CoreOS release note yaml snippets which will be picked up by `fedora-coreos-releng-automation/coreos-release-note-generator` [1] script to produce an intermediate `release-notes.yaml` which contains a `next-release` field. Then the intermediate yaml file would be updated to reflect the actual build ID for a release. After `release-notes.yaml` has been generated and updated, snippets under `release-notes.d` are expected to be cleaned up for future release notes.
7
4
8
-
Release notes will be organized according to the origin of the change, i.e. the project name.
9
-
Other miscellaneous changes will be stored under `miscellaneous`. Therefore, the schema
10
-
of each yaml snippet is designed as follows:
5
+
Release notes will be organized according to the origin of the change, i.e. the project name. Otherwise miscellaneous changes will be stored under `miscellaneous`. Therefore, the schema of each yaml snippet is designed as follows:
11
6
12
7
```yaml
13
8
# Each yaml file consists of a list of dictionaries which looks like this
@@ -16,14 +11,36 @@ of each yaml snippet is designed as follows:
16
11
body (optional): xxxxx
17
12
```
18
13
19
-
The final rendered version is expected to be:
14
+
An example intermediate `release-notes.yaml` generated from `release-notes.d` is expected to be:
15
+
```
16
+
- next-release:
17
+
coreos-assembler:
18
+
- add a new sub-command that automates xxx (details)
19
+
- fix a bug that result in https://github.com/coreos/fedora-coreos-tracker/issues/xxx
20
+
miscellaneous:
21
+
- introduce a new config file to facilitate xxx workflow (details)
22
+
- 32.20200706.3.0:
23
+
afterburn:
24
+
- add support for platform xxx
25
+
- 32.20200620.1.0:
26
+
ignition:
27
+
- fix a minor issue https://github.com/coreos/fedora-coreos-tracker/issues/xxx
28
+
```
20
29
30
+
The final rendered version is expected to be:
21
31
```
22
-
32.20200715.3.0:
23
-
- coreos-assembler:
24
-
add a new sub-command that automates xxx (details)
25
-
- miscellaneous:
26
-
introduce a new config file to facilitate xxx workflow (details)
32
+
- 32.20200715.3.0:
33
+
- coreos-assembler:
34
+
- add a new sub-command that automates xxx (details)
35
+
- fix a bug that result in https://github.com/coreos/fedora-coreos-tracker/issues/xxx
36
+
- miscellaneous:
37
+
- introduce a new config file to facilitate xxx workflow (details)
38
+
- 32.20200706.3.0:
39
+
afterburn:
40
+
- add support for platform xxx
41
+
- 32.20200620.1.0:
42
+
ignition:
43
+
- fix a minor issue https://github.com/coreos/fedora-coreos-tracker/issues/xxx
27
44
```
28
45
29
46
_Note_: Clicking on the `details` button will show the body of the release note item.
0 commit comments