epics/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Add links to older release notes files, update wording

Browse Source
This commit is contained in:
Andrew Johnson
2025-04-24 17:01:48 -05:00
parent 7b010cecd8
commit 91063e4caa
4 changed files with 74 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
documentation/new-notes/PR-628.md
View File

@@ -2,21 +2,28 @@
GitHub [PR #628](https://github.com/epics-base/epics-base/pull/628)
This release replaces the single `documentation/RELEASE_NOTES.md` file in the
EPICS source tree with a mechanism that should prevent merge conflicts when new
entries are added from multiple pull requests.
This release replaces the developer-edited `documentation/RELEASE_NOTES.md`
source file in the EPICS tree with a process that generates one file from
individual files added for each changeset, thus preventing merge conflicts
when new entries are added by multiple pull requests.
In this new approach each pull request will add a separate Markdown file to the
`documentation/new-notes` directory with a unique name.
Instructions on creating new entries are provided in a `README.txt` file in the
`documentation/new-notes` directory.
For this new approach each pull request must add its own Markdown file to the
`documentation/new-notes` directory, using a unique filename.
When a release is made, all these files will be combined into a single
`RELEASE-<version>.md` file and the `new-notes` directory emptied to prepare
for development of the next release.
All these files will be combined into a single `RELEASE-<version>.md` file when
a release is made, and the `new-notes` directory emptied to prepare for
development of the next release.
The build process now descends into the `documentation` directory where the
`RELEASE_NOTES.md` file is generated and installed into the `doc` top-level
directory along with the `RELEASE-<version>.md` files documenting older EPICS
releases going back to 3.15.
Between releases, running `make` in the `documentation` directory will combine
all the new entries into a single `RELEASE_NOTES.md` file that then gets
installed into the `doc` top-level directory.
That `make` command will also install the older `RELEASE-<version>.md` files
into the `doc` directory.
Between releases the generated `RELEASE_NOTES.md` file contains the text from
any `new-notes` files added to document changes already merged.
It also provides links to the older `RELEASE-<version>.md` files, so it remains
the starting point for documentation on all release changes.
Detailed instructions on creating new entries are provided in a `README.txt`
file in the `documentation/new-notes` directory.
The release-time process that generates a new `RELEASE-<version>.md` file is
described in the `documentation/ReleaseChecklist.html` file.