Stage for release of v3.1.4.0-beta (#4866)

lgritz · web-flow · commit 8606e1a610d6 · 2025-08-22T10:08:57.000-07:00
Signed-off-by: Larry Gritz &lt;lg@larrygritz.com&gt;
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,6 +1,6 @@
 Release 3.1 (target: Sept 2025?) -- compared to 3.0
 ---------------------------------------------------
-- Anticipated beta: Aug 15, 2025
+- Beta 1: Aug 22, 2025
 - Anticipated release candidate: Sep 1, 2025
 - Anticipated supported release: Sep 15, 2025
 
@@ -13,16 +13,15 @@ ABI compatibility, but we do expect some behavior changes.
   - oiiotool new commands: `--layersplit`, `--pastemeta`, `--demosaic`,
     `create-dir` and new expression expansion tokens: `IS_CONSTANT`,
     `IS_BLACK`, `SUBIMAGES`.
-  - New IBA image processing functions: `scale()`, `demosaic`.
+  - New IBA image processing functions: `scale()`, `demosaic()`.
   - New 2-level namespace scheme that we hope will make it possible in the
     future for our annual releases to NOT need to break backward ABI
     compatibility.
   - Support in Python for `ImageBuf._repr_png_` method allows use of OIIO
     inside [Jupyter Notebooks](https://jupyter.org/) to display computed
     images.
-  - Color management improvements (some TBD, not landed yet) to conform to
-    Color Interchange Forum and OpenEXR new conventions for naming and
-    specifying color spaces.
+  - Color management improvements to conform to Color Interchange Forum and
+    OpenEXR new conventions for naming and specifying color spaces.
 
 ### New minimum dependencies and compatibility changes:
 * *Python*: 3.9 minimum (from 3.7) [#4830](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4830) (3.1.4.0)
@@ -72,6 +71,7 @@ ABI compatibility, but we do expect some behavior changes.
     - *api*: Add new ImageInput::supports() query: "mipmap" [#4800](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4800) (3.1.3.0)
 * Color management changes
     - *color mgmt*: Don't assume unlabeled OpenEXR files are lin_rec709 [#4840](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4840) (3.1.4.0)
+    - *color mgmt*: Color space renaming to adhere to CIF conventions [#4860](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4860) (3.1.4.0)
 
 
 ### 🚀  Performance improvements:
@@ -200,7 +200,8 @@ ABI compatibility, but we do expect some behavior changes.
     - *windows*: Include Windows version information on produced binaries [#4696](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4696) (by Jesse Yurkovich) (3.1.3.0)
     - windows + ARM64*: Add arm_neon.h include on Windows ARM64 with clang-cl [#4691](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4691) (by Anthony Roberts)
     - *build/windows*: Propagate CMAKE_MSVC_RUNTIME_LIBRARY [#4842](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4842) (3.1.4.0)
-    * *deps*: Raise OpenColorIO minimum to 2.3 (from 2.2) [#4865](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4865) (3.1.4.0)
+    - *deps*: Raise OpenColorIO minimum to 2.3 (from 2.2) [#4865](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4865) (3.1.4.0)
+    - *NetBSD*: Fix build on NetBSD [#4857](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4857) (by Thomas Klausner) (3.1.4.0)
 * Testing and Continuous integration (CI) systems:
     - *tests*: Improve Ptex testing [#4573](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4573) (3.1.1.0)
     - *tests*: Better testing coverage of null image reader/writer [#4578](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4578) (3.1.1.0)
@@ -245,6 +246,8 @@ ABI compatibility, but we do expect some behavior changes.
     - *ci*: Bump 'latest releases' tests to use pybind11 3.0.0 [#4828](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4828) (3.1.4.0)
     - *ci*: For python stub generation, lock pybind11 to pre-3.0 [#4831](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4831) (3.1.4.0)
     - *ci*: Add a VFX Platform 2026 CI job [#4856](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4856) (3.1.4.0)
+    - *ci*: Lock down to ci-oiio container with correct llvm components [#4859](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4859) (3.1.4.0)
+    - *ci*: Bump webp and openexr for "latest versions" test [#4861](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4861) (3.1.4.0)
 
 ### 📚  Notable documentation changes:
   - *docs*: Clarify 'copy_image' example [#4522](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4522) (3.1.0.0/3.0.1.0)
@@ -270,6 +273,7 @@ ABI compatibility, but we do expect some behavior changes.
   - *admin*: Update SECURITY to reflect that 2.5 only gets critical fixes now [#4829](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4829)
 
 
+
 ---
 ---
 
diff --git a/CREDITS.md b/CREDITS.md
@@ -224,6 +224,7 @@ lg@openimageio.org
 * Stefan Stavrev
 * Thiago Ize
 * Thomas Dinges
+* Thomas Klausner
 * Thomas Mansencal
 * Till Dechent
 * Tim D. Smith
diff --git a/SECURITY.md b/SECURITY.md
@@ -8,9 +8,10 @@ security vulnerabilities.
 | Version / branch  | Supported                                            |
 | ----------------- | ---------------------------------------------------- |
 | main              | :white_check_mark: :construction: ALL fixes immediately, but this is a branch under development with a frequently unstable ABI and occasionally unstable API. |
+| 3.1.x             | :white_check_mark: All fixes that can be backported without breaking ABI compatibility. New tagged releases monthly. |
 | 3.0.x             | :white_check_mark: All fixes that can be backported without breaking ABI compatibility. New tagged releases monthly. |
 | 2.5.x             | :warning: Bug fixes backported only if critical or upon request (and if we are able to cleanly backport). New tagged releases only occasionally. |
-| <= 2.4.x          | :x: No longer receiving patches of any kind.        |
+| < 2.5.x          | :x: No longer receiving patches of any kind.        |
 
 
 ## Reporting a Vulnerability
diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md
@@ -98,6 +98,6 @@ bring it up at a TSC meeting, or on the mail list or Slack channel.
 ## Parking
 
 Here is where we will put things that definitely should be on the roadmap, but
-that need not be completed in time for the fall 2024 release of OIIO 3.0.
+that need not be completed in time for the fall 2026 release of OIIO 3.2.
 
 ...
diff --git a/docs/dev/RELEASING.md b/docs/dev/RELEASING.md
@@ -178,7 +178,7 @@ have a heading added at the top for the *next* version.
      minor releases, so it's ok/encouraged to make a deprecated function from
      linked to inline, for example (which might allow it to be removed later
      without an ABI change).
-   - Major releases (a.b.c.d -> A+1.b.c.d): API compatibility breaks are
+   - Major releases (a.b.c.d -> A+1.0.0.0): API compatibility breaks are
      allowed here, so this is the time to completely remove any functions that
      have already had a full minor release where they had been given
      deprecation warning macros.
@@ -312,22 +312,22 @@ The following are the steps for making the release:
 
    For a monthly patch release:
 
-    > We have tagged v3.0.1.2 as the latest production release and moved the
+    > We have tagged v3.1.0.0 as the latest production release and moved the
     > "release" branch marker to that point.  This is guaranteed to be API,
-    > ABI, and link back-compatible with prior 3.0 releases. Release notes
+    > ABI, and link back-compatible with prior 3.1 releases. Release notes
     > can be found at *LINK TO THE GITHUB RELEASE PAGE.*
 
    For an annual major/minor release:
 
-    > OpenImageIO version 3.0 has been released! Officially tagged as
-    > "v3.0.0.0", we have also moved the "release" branch tag to this
-    > position. Henceforth, 3.0 is the supported production release family.
-    > The API is now frozen -- we promise that subsequent 3.0.x releases
+    > OpenImageIO version 3.1 has been released! Officially tagged as
+    > "v3.1.0.0", we have also moved the "release" branch tag to this
+    > position. Henceforth, 3.1 is the supported production release family.
+    > The API is now frozen -- we promise that subsequent 3.1.x releases
     > (which should happen monthly) will not break back-compatibility of API,
     > ABI, or linkage, compared to this release. Please note that this release
     > is *not* ABI or link compatible with 2.5 or older releases.
     > 
-    > Release notes for 3.0 outlining all the changes since last year's
+    > Release notes for 3.1 outlining all the changes since last year's
     > release can be found at *LINK TO THE GITHUB RELEASE PAGE.*
     > (Optionally, you can include a brief summary of the most important
     > changes in this email.)
@@ -344,7 +344,7 @@ The following are the steps for making the release:
     > backward-compatible with prior versions, warn about that here.)
     > 
     > Enjoy, and please report any problems. We will continue to make patch
-    > releases to the 3.0 family roughly monthly, which will contain bug fixes
+    > releases to the 3.1 family roughly monthly, which will contain bug fixes
     > and non-breaking enhancements.
     > 
     > The older 2.5 series of releases is now considered obsolete. We will
@@ -357,22 +357,22 @@ The following are the steps for making the release:
     > not make any compatibility guarantees and don't guarantee continuing API
     > compatibility in main.
     >
-    > (Paste the full set of 3.0 changes here, just copy the appropriate
+    > (Paste the full set of 3.1 changes here, just copy the appropriate
     > part of CHANGES.md)
 
    For a beta leading up to the annual major/minor release:
 
-    > OpenImageIO version 3.0 is now in beta, tagged as "v3.0.0.0-beta". We
+    > OpenImageIO version 3.1 is now in beta, tagged as "v3.1.0.0-beta". We
     > will try very hard not to make any further API or ABI changes between
     > now and the final release (unless it is absolutely necessary to fix
-    > an important problem identified during beta testing). The final 3.0
+    > an important problem identified during beta testing). The final 3.1
     > release is scheduled for [DATE GOES HERE], so please try building and
     > testing the beta so we are sure to find any problems.
     > 
-    > Release notes for 3.0 outlining all the changes since last year's
+    > Release notes for 3.1 outlining all the changes since last year's
     > release are below.
     > 
-    > (Paste the full set of 3.0 changes here, just copy the appropriate
+    > (Paste the full set of 3.1 changes here, just copy the appropriate
     > part of CHANGES.md)
 
 
@@ -414,9 +414,9 @@ notes process be simpler and more automated.
 We have been using the [git-cliff](https://github.com/orhun/git-cliff) tool
 as the starting point for release notes. The command we use is:
 
-    git cliff -c src/doc/cliff.toml v1.2.3.4..HEAD > cliff.out.md
+    git cliff -c src/doc/cliff.toml v3.1.2.3..HEAD > cliff.out.md
 
-where v1.2.3.4 in this example is the tag of the last release. You could also
+where v3.1.2.3 in this example is the tag of the last release. You could also
 use commit hashes to denote the range of changes you want to document.
 
 **For monthly patch releases**
