Skip to content

Commit e64b2cb

Browse files
authored
Revise RELEASING to explain updating oiio-images branch (#3580)
1 parent 33c0181 commit e64b2cb

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

RELEASING.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,14 @@ have a heading added at the top for the *next* version.
189189
- The `${PROJECT_NAME}_SUPPORTED_RELEASE` variable should be `ON` for any
190190
release branch, `OFF` for master.
191191

192-
5. Make sure everything passes the usual CI workflow. Also check the daily or
192+
5. In the https://github.com/OpenImageIO/oiio-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
195+
checkout of oiio-images to ensure CI tests are against the set of test
196+
images corresponding to that major/minor release (just in the branch, not
197+
in master!).
198+
199+
6. Make sure everything passes the usual CI workflow. Also check the daily or
193200
weekly "analysis" workflows to make sure there aren't any important
194201
warnings that should be fixed.
195202

@@ -330,10 +337,11 @@ Odds and ends to do after the tag is pushed and the announcements are sent:
330337
- Re-read RELEASING.md and ensure that the instructions match what you
331338
have done. Update as necessary.
332339

333-
- Go to readthedocs.org, and ensure that the new release is built and visible.
334-
I tend to keep the latest patch of each minor release available for
335-
reference indefinitely, but hide the docs for earlier patch releases within
336-
that minor release series.
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.
337345

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

src/build-scripts/install_test_images.bash

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
#!/usr/bin/env bash
22

33
if [[ ! -e ../oiio-images ]] ; then
4-
git clone https://github.com/OpenImageIO/oiio-images.git ../oiio-images
4+
git clone https://github.com/OpenImageIO/oiio-images.git -b master --depth 1 ../oiio-images
5+
# NOTE: on release branches, this should include `-b RB-x.y`` so that
6+
# updates to the master oiio-images don't break tests in release branches.
57
fi
68

79
# if [[ ! -e ../libtiffpic ]] ; then
@@ -10,7 +12,7 @@ fi
1012
# fi
1113

1214
if [[ ! -e ../openexr-images ]] ; then
13-
git clone https://github.com/openexr/openexr-images.git ../openexr-images
15+
git clone https://github.com/openexr/openexr-images.git --depth 1 ../openexr-images
1416
fi
1517

1618
# if [[ ! -e ../bmpsuite ]] ; then

0 commit comments

Comments
 (0)