diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e1ca5ea850..e57351446c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -406,8 +406,8 @@ jobs: pybind11_ver: v3.0.0 simd: "avx2,f16c" skip_tests: 1 - # abi_check: v3.1.3.0 - abi_check: 9bfcce725a3806a3f70c7e838d9d98d6d95c917a + # abi_check: v3.1.6.0 + abi_check: d4c8024633dba8bb3c01d22b65ce9bc7a1ae215e setenvs: export OIIO_CMAKE_FLAGS="-DOIIO_BUILD_TOOLS=0 -DOIIO_BUILD_TESTS=0 -DUSE_PYTHON=0" USE_OPENCV=0 USE_FFMPEG=0 USE_PYTHON=0 USE_FREETYPE=0 optional_deps_append: "openjph;Qt6" diff --git a/CHANGES.md b/CHANGES.md index 38620323e5..8d1b9cf96b 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -13,6 +13,7 @@ Release 3.2 (target: Sept 2026?) -- compared to 3.1 - *api*: Versioned namespace to preserve ABI compatibility between minor releases [#4869](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4869) (3.2.0.0) ### 🚀 Performance improvements ### 🐛 Fixes and feature enhancements + - *jpeg-xl*: ICC read and write for JPEG-XL files (issue 4649) [#4905](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4905) (by shanesmith-dwa) (3.2.0.0) ### 🔧 Internals and developer goodies ### 🏗 Build/test/CI and platform ports * OIIO's CMake build system and scripts: @@ -20,45 +21,23 @@ Release 3.2 (target: Sept 2026?) -- compared to 3.1 * Testing and Continuous integration (CI) systems: ### 📚 Notable documentation changes ### 🏢 Project Administration +### 🤝 Contributors --- --- -Release 3.1 (target: Oct 1 2025?) -- compared to 3.0 ----------------------------------------------------- +Release 3.1 (Oct 2 2025) -- compared to 3.0.x +----------------------------------------------------- - Beta 1: Aug 22, 2025 - Beta 2: Sep 19, 2025 -- Anticipated release candidate: Sep 24, 2025 -- Anticipated supported release: Oct 1, 2025 - -**Change highlights in beta 2** - - *oiiotool*: Allow easy splitting of subimages by name [#4874](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4874) (3.1.5.0) - - *ffmpeg*: Add ability to read CICP metadata [#4882](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4882) (by Brecht Van Lommel) (3.1.5.0) - - *ffmpeg*: FFmpeg incorrectly set zero oiio:BitsPerSample [#4885](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4885) (by Brecht Van Lommel) (3.1.5.0) - - *gif*: Gif output didn't handle FramesPerSecond attribute correctly [#4890](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4890) (3.1.5.0) - - *heic*: Read and write of CICP and support for bit depth 10 and 12 [#4880](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4880) (by Brecht Van Lommel) (3.1.5.0) - - *png*: CICP metadata support for PNG [#4746](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4746) (by Zach Lewis) (3.1.5.0) - - *raw*: Add thumbnail support to the raw input plugin [#4887](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4887) (by Anton Dukhovnikov) (3.1.5.0) - - *webp*: Support reading/writing the ICCProfile attribute [#4878](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4878) (by Jesse Yurkovich) (3.1.5.0) - - *api*: Versioned namespace to preserve ABI compatibility between minor releases [#4869](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4869) (3.1.5.0) - - *deps(freetype)*: Test freetype 2.14 and document that it works [#4876](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4876) (3.1.5.0) - - *deps(ffmpeg)*: Ffmpeg 8 support [#4870](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4870) (3.1.5.0) - - *deps(openvdb)*: Look for boost headers for OpenVDBs older than 12 [#4873](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4873) (by Alex Fuller) (3.1.5.0) - - *deps(openexr)*: OpenEXR 3.4 supports two compression types for HTJ2K [#4871](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4871) (by Todica Ionut) (3.1.5.0) - - *deps(openexr)*: Several OpenEXR and OpenJPH build related fixes [#4875](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4875) (3.1.5.0) - - *deps(openjph)*: Fix openjph target use [#4894](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4894) (3.1.5.0) - - *ci*: Fix broken python wheel building [#4855](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4855) (by Zach Lewis) (3.1.5.0) - - -**NOTE:** We anticipate some additional changes to color management to be -rolled out during the beta period. It will not include any breaks to API or -ABI compatibility, but we do expect some behavior changes. +- Release candidate 1: Sep 27, 2025 +- Full release, v3.1.6.1: Oct 2, 2025 **Executive Summary / Highlights:** - New image file support: Ultra HDR (HDR images in JPEG containers). - oiiotool new commands: `--layersplit`, `--pastemeta`, `--demosaic`, - `create-dir` and new expression expansion tokens: `IS_CONSTANT`, + `--create-dir` and new expression expansion tokens: `IS_CONSTANT`, `IS_BLACK`, `SUBIMAGES`. - New IBA image processing functions: `scale()`, `demosaic()`. - New 2-level namespace scheme that we hope will make it possible in the @@ -134,22 +113,23 @@ ABI compatibility, but we do expect some behavior changes. ### 🐛 Fixes and feature enhancements: - *oiiotool*: Better handling of wildcards that match no files [#4627](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4627) (3.1.1.0) - - *oiotool*: Invalid loop bound when appending mipmap textures using oiiotool [#4671](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4671) (by Basile Fraboni) (3.1.1.0) + - *oiiotool*: Invalid loop bound when appending mipmap textures using oiiotool [#4671](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4671) (by Basile Fraboni) (3.1.1.0) - *oiiotool*: -i:native=1, fix --native behavior, fix convert datatype [#4708](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4708) (3.1.3.0) - *oiiotool*: Fixes to --missingfile behavior [#4803](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4803) (3.1.3.0) - *oiiotool*: Allow thread control for --parallel-frames [#4818](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4818) (3.1.3.0) + - *oiiotool*: Use normalized path when creating wildcard path pattern [#4904](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4904) (by Jesse Yurkovich) (3.1.6.0) + - *oiiotool*: Ignore empty subimage(s) when calculating non-zero region [#4909](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4909) (by Carine Touraille) (3.1.6.0) - *color mgmt*: Support OCIO Viewing Rules, other OCIO-related improvements [#4780](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4780) (by zachlewis) (3.1.3.0) - *iv*: Fix crash on .DS_Store; fix uppercase extensions [#4764](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4764) (by Anton Dukhovnikov) (3.1.3.0) - *iv*: Do not resize on open and other zoom fixes [#4766](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4766) (by Aleksandr Motsjonov) (3.1.3.0) - *iv*: Bug fix for iv window losing focus on mac on startup [#4773](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4773) (by Aleksandr Motsjonov) (3.1.3.0) - *iv*: Use screen pixel ratio to render sharp text in pixel view tool [#4768](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4768) (by Aleksandr Motsjonov) (3.1.3.0) - *IBA*: IBA:demosaic add white balancing [#4499](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4499) (by Anton Dukhovnikov) (3.1.0.0/3.0.1.0) - - *IBA*: IBA:demosaic add white balancing [#4499](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4499) (by Anton Dukhovnikov) (3.1.0.0/3.0.1.0) - *IBA*: IBA::demosaic - fix roi channels [#4602](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4602) (by Anton Dukhovnikov) (3.1.1.0) - *IBA*: Add 'auto' value for all options of `IBA::demosaic()` [#4786](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4786) (by Anton Dukhovnikov) (3.1.3.0) - *ImageBuf*: IB::pixeltype() did not always return the right value [#4614](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4614) (3.1.1.0) - *ImageBuf*: Fix bug in ImageBuf construction from ptr + neg strides [#4630](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4630) (3.1.1.0) - - *ImageBuf*: Better errors for nonexistant subimages/mips [#4801](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4801) (3.1.3.0) + - *ImageBuf*: Better errors for nonexistent subimages/mips [#4801](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4801) (3.1.3.0) - *ImageInput*: Incorrect IOProxy logic related to valid_file [#4839](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4839) (3.1.4.0) - *python*: Disable loading Python DLLs from PATH by default on Windows [#4590](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4590) (by zachlewis) (3.1.1.0) - *python*: Fix handle leak [#4685](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4685) (3.1.3.0) @@ -197,7 +177,7 @@ ABI compatibility, but we do expect some behavior changes. - *int*: Switch to spans for some exif manipulation, fixing warnings [#4689](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4689) (3.1.1.0) - *int*: Rearrange initialize_cuda() for better err check, no warn [#4726](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4726) (3.1.3.0) - *int*: Experimental default_init_allocator and default_init_vector [#4677](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4677) (3.1.3.0) - - *int*: Address some nickpick sonar warnings about TileID initialization [#4722](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4722) (3.1.3.0) + - *int*: Address some nitpick sonar warnings about TileID initialization [#4722](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4722) (3.1.3.0) - *int*: Address safety warnings in pvt::append_tiff_dir_entry [#4737](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4737) (3.1.3.0) - *int*: ImageInput/ImageOutput did not set per-file threads correctly [#4750](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4750) (3.1.3.0) - *int/iv*: Add raw string syntax modifier for VSCode and Cursor to understand its glsl [#4796](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4796) (by Aleksandr Motsjonov) (3.1.3.0) @@ -239,6 +219,7 @@ ABI compatibility, but we do expect some behavior changes. - *build*: Fix typo related to finding ccache [#4833](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4833) (3.1.4.0) - *build*: C++23 support [#4844](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4844) (3.1.4.0) - *build*: Clean up obsolete logic for old compilers [#4849](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4849) (3.1.5.0) + - *build*: Update autobuild defaults for some dependencies [#4910](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4910) (3.1.6.1) * Dependency and platform support: - *build(OCIO)*: Support static OCIO self-builds [#4517](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4517) (by zachlewis) (3.1.0.0/3.0.1.0) - *build(PNG)*: Add build recipe for PNG [#4423](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4423) (by zachlewis) (3.1.0.0/3.0.1.0); PNG auto-build improvements [#4835](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4835) (3.1.4.0) @@ -261,10 +242,12 @@ ABI compatibility, but we do expect some behavior changes. - *deps(openjph)*: Fix openjph target use [#4894](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4894) (3.1.5.0) - *deps(openvdb)*: Look for boost headers for OpenVDBs older than 12 [#4873](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4873) (by Alex Fuller) (3.1.5.0) - *deps(python)*: Raise minimum supported Python from 3.7 to 3.9 [#4830](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4830) (3.1.4.0) + - *deps(opencolorio)*: Support for OpenColorIO 2.5 [#4916](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4916) (3.1.6.1) - *windows*: Include Windows version information on produced binaries [#4696](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4696) (by Jesse Yurkovich) (3.1.3.0) - *windows*: Propagate CMAKE_MSVC_RUNTIME_LIBRARY [#4842](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4842) (3.1.4.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) - *NetBSD*: Fix build on NetBSD [#4857](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4857) (by Thomas Klausner) (3.1.4.0) + - *build*: Fix some build issues encountered on a musl libc system [#4903](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4903) (by omcaif) (3.1.6.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) @@ -311,11 +294,14 @@ ABI compatibility, but we do expect some behavior changes. - *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) - - *ci*: Switch to compile-commands for sonar [#4879](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4879) (by vvalderrv) (3.1.5.0) + - *ci*: Try to fix Sonar workflow by switching to compile-commands for sonar [#4879](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4879) (by vvalderrv) (3.1.5.0) - *ci*: Fix analysis workflow configuration [#4881](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4881) (3.1.5.0) - *ci*: Better spread of libpng versions we test against [#4883](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4883) (3.1.5.0) - *ci*: Fix broken python wheel building [#4855](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4855) (by Zach Lewis) (3.1.5.0) - *ci*: Some more minor wheel workflow changes after the py 3.9 bump [#4867](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4867) (3.1.5.0) + - *ci*: More Sonar scan workflow fixes [#4902](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4902) (by vvalderrv) (3.1.6.0) + - *ci*: Add more exceptions to when we test docs building [#4899](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4899) (3.1.6.0) + - *ci*: Require all dependencies, with explicit exceptions [#4898](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4898) (3.1.6.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) @@ -330,6 +316,7 @@ ABI compatibility, but we do expect some behavior changes. - *docs*: Online docs improvements, mostly formatting [#4736](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4736) (3.1.3.0) - *docs*: Update Windows build instructions to rely on deps auto-build [#4769](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4769) (3.1.3.0) - *docs*: Correct docs and type of "resident_memory_used_MB" attribute [#4824](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4824) (3.1.4.0) + - *docs/python*: Add type hints to Python docs and tests [#4908](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4908) (by Connie Chang) (3.1.6.0) ### 🏢 Project Administration - *admin*: Code review guidelines and tips [#4532](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4532) (3.1.0.0/3.0.1.0) @@ -341,11 +328,42 @@ 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) - *admin*: Adjust license notices of A2-only source [#4884](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4884) (3.1.5.0) +### :handshake: Contributors + +During the course of development of 3.1 (since splitting from the 3.0 branch), +OpenImageIO has had 40 unique contributors, of which 15 (indicated by an +asterisk) had not previously contributed to the project. + +| | | | +| ----------------------- | ------------------- | -------------------- | +| Aleksandr Motsjonov (*) | Alex Fuller (*) | Anthony Roberts (*) | +| Anton Dukhovnikov | Aras Pranckevičius | Basile Fraboni | +| Brecht Van Lommel | Campbell Barton (*) | Carine Touraille (*) | +| Chad Dombrova | Connie Chang (*) | Danielle Imogu (*) | +| Dharshan Vishwanatha | Don Olmstead (*) | Jesse Yurkovich | +| Joachim Reichel | Jonathan Brown | kaarrot | +| Larry Gritz | LI JI (*) | Loïc Vital | +| Lukas Stockner | Lydia Zheng | Mikael Sundell | +| Oktay Comu (*) | omcaif (*) | Peter Kovář | +| Peter Horvath | pfranz | Rui Chen (*) | +| Sam Richards | Scott Milner (*) | Scott Wilson | +| Thomas Klausner (*) | Todica Ionut | toge | +| Vanessa Valderrama (*) | Vernal Chen | Vlad (Kuzmin) Erium | +| Zach Lewis | | | --- --- +Release 3.0.11.0 (Oct 1, 2025) -- compared to 3.0.10.1 +------------------------------------------------------- + - *oiiotool*: Allow easy splitting output of subimages by name [#4874](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4874) + - *webp*: Support reading/writing the ICCProfile attribute for WepP files[#4878](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4878) (by Jesse Yurkovich) + - *gif*: GIF output didn't handle FramesPerSecond attribute correctly [#4890](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4890) + - *deps*: Test freetype 2.14 and document that it works [#4876](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4876) + - *deps*: Look for boost headers for OpenVDBs older than 12 [#4873](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4873) (by Alex Fuller) + + Release 3.0.10.1 (Sep 16, 2025) -- compared to 3.0.10.0 ------------------------------------------------------- - *ci*: Fix broken python wheel building [#4886](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4886) [#4855](https://github.com/AcademySoftwareFoundation/OpenImageIO/pull/4855) (by Zach Lewis) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3c9d673dc..1e0cfbdf23 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,37 +1,29 @@ Contributing to OpenImageIO =========================== -> NOTE: This is the proposed post-ASWF-move version of CONTRIBUTING. After the -> project is legally transferred and moved to the new repo, this file will -> replace the one at the project root. -> -> TO DO: -> -> - [X] Update the mail list sign-up page after the mail list moves. -> - [ ] Update the repo URL -> - [ ] Double check the security and info email addresses. -> - -Code contributions to OpenImageIO are always welcome, and [nearly 200 +Code contributions to OpenImageIO are always welcome, and [nearly 250 people](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/CREDITS.md) have done so over the years. Please review this document to get a briefing on our process. +General Tips for Open Source Development +---------------------------------------- + +* GitHub's [Open Source Guides](https://opensource.guide/) + - Especially the guide on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) + + Mail List and Slack ------------------- -Contributors should be reading the oiio-dev mail list: - * [oiio-dev](https://lists.aswf.io/g/oiio-dev) For developers of the OpenImageIO code itself, or users who are really interested in the OIIO internals. This is where we mostly discuss the code (including bug reports), but are also happy to answer user questions about -use or working of OIIO. - -You can sign up for the mail list on your own using the link above. +use or working of OIIO. You can sign up for the mail list on your own using the link above. -The [ASWF Slack](https://slack.aswf.io/) has an `openimageio` channel. Sign up +* [ASWF Slack](https://slack.aswf.io/) has an `openimageio` channel. Sign up for the Slack on your own, then under "channels", select "browse channels" and you should see the openimageio channel (among those of the other projects and working groups). @@ -55,7 +47,7 @@ enhancements: https://github.com/AcademySoftwareFoundation/OpenImageIO/issues **If you are merely asking a question ("how do I...")**, please do not file an issue, but instead ask the question on the [oiio-dev mailing -list](https://lists.aswf.io/g/oiio-dev). +list](https://lists.aswf.io/g/oiio-dev) or on the Slack channel. If you are submitting a bug report, please be sure to note which version of OIIO you are using, on what platform (OS/version, which compiler you used, @@ -215,7 +207,7 @@ under `fix:`, because that appears first in the list). It is also encouraged, when it makes sense to do so, to put a subcategory in parenthesis after the prefix, like `fix(exr):` or `feat(IBA):`. It's ok to use obvious abbreviations for major classes or subsections: IB=ImageBuf, -IBA=ImageBufAlgo, IC=ImageCace, TS=TextureSystem, etc. If there is no clear +IBA=ImageBufAlgo, IC=ImageCache, TS=TextureSystem, etc. If there is no clear single format or class that is the man focus of the patch, then you can omit the subcategory. diff --git a/CREDITS.md b/CREDITS.md index 3629969eb3..6d01f85972 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -48,6 +48,7 @@ lg@openimageio.org * Brian Hall * Brice Gros * Campbell Barton +* Carine Touraille * Carl Rand * Cassian Andrei * Chad Dombrova @@ -61,6 +62,7 @@ lg@openimageio.org * Christoph Willing * Clément Champetier * Cliff Stein +* Connie Chang * Curtis Black * D-Spirits * Dalai Felinto @@ -180,6 +182,7 @@ lg@openimageio.org * Nuno Cardoso * Oktay Comu * Ole Gulbrandsen +* omcaif * Ott Tinn * Pascal Lecocq * Patrick Hodoul diff --git a/README.md b/README.md index 72c2644e7e..0b6728634b 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ security-related issues [security@openimageio.org](security@openimageio.org). 🔧 Contributing and developer documentation ------------------------------------------- -OpenImageIO welcomes code contributions, and [nearly 200 people](CREDITS.md) +OpenImageIO welcomes code contributions, and [nearly 250 people](CREDITS.md) have done so over the years. We take code contributions via the usual GitHub pull request (PR) mechanism. @@ -155,6 +155,11 @@ pull request (PR) mechanism. building the documentation locally, which may be helpful if you are editing the documentation in nontrivial ways and want to preview the appearance. * Other developer documentation is in the [docs/dev](docs/dev) directory. +* You may also have luck learning a bit about the organization and + architecture of the project by reading the [DeepWiki Analysis of + OpenImageIO](https://deepwiki.com/AcademySoftwareFoundation/OpenImageIO). + But take it with a grain of salt -- like any LLM-generated summary, there + may be inaccuracies lurking. ☎️ Communications channels and additional resources diff --git a/SECURITY.md b/SECURITY.md index 1fc108aa7a..60c1f1bcb3 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -9,9 +9,8 @@ security vulnerabilities. | ----------------- | ---------------------------------------------------- | | 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.5.x | :x: No longer receiving patches of any kind. | +| 3.0.x | :warning: Important fixes that can be easily backported without breaking ABI compatibility. New tagged releases as needed, and becoming less frequent over time. | +| <= 2.5.x | :x: No longer receiving patches of any kind. | ## Reporting a Vulnerability diff --git a/docs/dev/RELEASING.md b/docs/dev/RELEASING.md index 3d2233a348..e0d88fded0 100644 --- a/docs/dev/RELEASING.md +++ b/docs/dev/RELEASING.md @@ -325,7 +325,7 @@ The following are the steps for making the release: > 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. + > is *not* ABI or link compatible with 3.0 or older releases. > > Release notes for 3.1 outlining all the changes since last year's > release can be found at *LINK TO THE GITHUB RELEASE PAGE.* @@ -347,15 +347,15 @@ The following are the steps for making the release: > 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 - > continue for now to make 2.4 patch releases, but over time, these will + > The older 3.0 series of releases is now considered obsolete. We will + > continue for now to make 3.0 patch releases, but over time, these will > become less frequent and be reserved for only the most critical bug > fixes. > - > The "main" branch is now progressing toward an eventual 3.1 release next + > The "main" branch is now progressing toward an eventual 3.2 release next > fall. As usual, you are welcome to use main for real work, but we do > not make any compatibility guarantees and don't guarantee continuing API - > compatibility in main. + > compatibility within main. > > (Paste the full set of 3.1 changes here, just copy the appropriate > part of CHANGES.md)