Skip to content

Commit 6c9b0f5

Browse files
lgritzThiagoIze
andauthored
docs: update SECURITY and RELEASING documentation (#4138)
Signed-off-by: Larry Gritz <[email protected]> Co-authored-by: Thiago Ize <[email protected]>
1 parent 922e1f4 commit 6c9b0f5

File tree

3 files changed

+21
-18
lines changed

3 files changed

+21
-18
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ version](https://readthedocs.org/projects/openimageio/downloads/pdf/latest/).
104104

105105
👷 Building and installing OpenImageIO
106106
--------------------------------------
107-
- [Build and installation instructions](/INSTALL.md) for OpenImageIO. Such
107+
- [Build and installation instructions](INSTALL.md) for OpenImageIO. Such
108108
as it is. This could use some work, particularly for Windows.
109109

110110

RELEASING.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -170,14 +170,17 @@ have a heading added at the top for the *next* version.
170170

171171
3. Ensure docs are up to date:
172172

173-
- Actually read the [README.md](README.md), [INSTALL.md](INSTALL.md),
174-
and other repository docs and make sure all the information is up to
175-
date. Check the [CREDITS.md](CREDITS.md) against the recent repo history
176-
to be sure new contributors are listed.
177-
- Skim the primary user documentation to look for any obvious errors,
173+
- [README.md](README.md): Actually read it! Make sure it all seems
174+
accurate and up to date.
175+
- [INSTALL.md](INSTALL.md): Be sure that it accurately reflects the
176+
current minimum and latest-tested versions of each dependency.
177+
- [CREDITS.md](CREDITS.md): Check against the recent repo history to be
178+
sure new contributors are listed.
179+
- [SECURITY.md](SECURITY.md): Make sure it accurately reflects the
180+
status of which branches get updates.
181+
- Skim the [user documentation](https://openimageio.readthedocs.io/) to
182+
ensure it's building correctly and doesn't have any obvious errors,
178183
especially the parts that describe new features.
179-
- If we are using any online docs (like readthedocs), make sure it is
180-
building and looks correct on the web site.
181184

182185
4. Make sure the the top-level CMakeLists.txt file is updated:
183186

@@ -190,8 +193,8 @@ have a heading added at the top for the *next* version.
190193
release branch, `OFF` for master.
191194

192195
5. In the https://github.com/AcademySoftwareFoundation/OpenImageIO-images project, create a branch
193-
`RB-x.y` for the major/minor branch, and in the main oiio repo, update
194-
src/build-scripts/install_test_images.bash to specify `-b RB-x.y` in the
196+
`dev-x.y` for the major/minor branch, and in the main oiio repo, update
197+
src/build-scripts/install_test_images.bash to specify `-b dev-x.y` in the
195198
checkout of oiio-images to ensure CI tests are against the set of test
196199
images corresponding to that major/minor release (just in the branch, not
197200
in master!).
@@ -337,11 +340,11 @@ Odds and ends to do after the tag is pushed and the announcements are sent:
337340
- Re-read RELEASING.md and ensure that the instructions match what you
338341
have done. Update as necessary.
339342

340-
- Go to readthedocs.org, and ensure that the new release is built and visible
341-
and is the default release shown (specified in the Admin section). I tend to
342-
keep the latest patch of each minor release available for reference
343-
indefinitely, but hide the docs for earlier patch releases within that minor
344-
release series.
343+
- Go to [readthedocs.org](https://openimageio.readthedocs.io/), and ensure
344+
that the new release is built, visible, and is the default release shown
345+
(specified in the Admin section). I tend to keep the latest patch of each
346+
minor release available for reference indefinitely, but hide the docs for
347+
earlier patch releases within that minor release series.
345348

346349
- Edit the top-level CMakeList.txt to update the version to the *next*
347350
anticipated release on the branch, in order to ensure that anybody building

SECURITY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ security vulnerabilities.
88
| Version / branch | Supported |
99
| ----------------- | ---------------------------------------------------- |
1010
| master | :white_check_mark: :construction: ALL fixes immediately, but this is a branch under development with a frequently unstable ABI and occasionally unstable API. |
11-
| 2.4.x | :white_check_mark: All fixes that can be backported without breaking ABI compatibility. New tagged releases monthly. |
12-
| 2.3.x | :x: Only receives occasional critical fixes, upon request. |
13-
| <= 2.2.x | :x: No longer receiving patches of any kind. |
11+
| 2.5.x | :white_check_mark: All fixes that can be backported without breaking ABI compatibility. New tagged releases monthly. |
12+
| 2.4.x | :warning: Only receives occasional critical fixes, upon request, only if they can be easily backported. |
13+
| <= 2.3.x | :x: No longer receiving patches of any kind. |
1414

1515

1616
## Reporting a Vulnerability

0 commit comments

Comments
 (0)