PRE-1.5.1: Update release notes, build docs

garyo · garyo · commit db93e5a9bf37 · 2025-11-19T13:29:43.000-05:00
Signed-off-by: Gary Oberbrunner &lt;garyo@darkstarsystems.com&gt;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -264,8 +264,8 @@ required.
 
 ### Test Policy
 
-OpenFX does not yet have an automated CI or test process.
-
+OpenFX runs an automated CI build process on github. All builds must
+pass before merging a PR.
 
 #### Copyright Notices
 
diff --git a/Documentation/sources/Reference/ofxPropertiesReference.rst b/Documentation/sources/Reference/ofxPropertiesReference.rst
@@ -43,6 +43,8 @@ Properties Reference
 
 .. doxygendefine:: kOfxImageEffectPluginRenderThreadSafety
 
+.. doxygendefine:: kOfxImageEffectPropCPURenderSupported
+
 .. doxygendefine:: kOfxImageEffectPropClipPreferencesSlaveParam
 
 .. doxygendefine:: kOfxImageEffectPropColourManagementAvailableConfigs
@@ -153,6 +155,8 @@ Properties Reference
 
 .. doxygendefine:: kOfxImageEffectPropTemporalClipAccess
 
+.. doxygendefine:: kOfxImageEffectPropThumbnailRender
+
 .. doxygendefine:: kOfxImageEffectPropUnmappedFrameRange
 
 .. doxygendefine:: kOfxImageEffectPropUnmappedFrameRate
diff --git a/Documentation/sources/conf.py b/Documentation/sources/conf.py
@@ -14,7 +14,7 @@
 copyright = '''2025, OpenFX a Series of LF Projects, LLC.
 For web site terms of use, trademark policy and other project policies please see https://lfprojects.org/'''
 author = 'Contributors to the OpenFX Project'
-release = '1.5'
+release = '1.5.1'
 
 read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
 # -- General configuration ---------------------------------------------------
diff --git a/include/ofx.doxy b/include/ofx.doxy
@@ -38,7 +38,7 @@ PROJECT_NAME           = "OpenFX"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "1.5+"
+PROJECT_NUMBER         = "1.5.1"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
diff --git a/include/ofxGPURender.h b/include/ofxGPURender.h
@@ -162,6 +162,8 @@ only) - plug-in instance change (read/write)
                   rendering
      - "true"   - which means a host or plug-in can support CPU rendering
 
+  @version added in version 1.5.1.
+
 */
 #define kOfxImageEffectPropCPURenderSupported "OfxImageEffectPropCPURenderSupported"
 
diff --git a/include/ofxImageEffect.h b/include/ofxImageEffect.h
@@ -1189,6 +1189,8 @@ If the plugin descriptor has this property set to "true", the plugin is expected
     - Valid Values - This must be one of
       - "false"  - the plugin cannot render without spatial awareness and the host should bypass it for renders that require no spatial awareness.
       - "true"   - the plugin can render without spatial awareness. The host will indicate this type of render by setting kOfxImageEffectPropNoSpatialAwareness to "true" in the arguments passed to kOfxImageEffectActionBeginSequenceRender and kOfxImageEffectActionRender.
+
+  @version added in version 1.5.1.
  */
 #define kOfxImageEffectPropNoSpatialAwareness "OfxImageEffectPropNoSpatialAwareness"
 
@@ -1214,6 +1216,8 @@ A plugin could react to this property by
 - rendering a badge rather than a detailed effect unlikely to be visible in a thumbail
 - turning itself off in kOfxImageEffectActionIsIdentity
 - disabling temporal inputs in kOfxImageEffectActionGetFramesNeeded
+
+  @version added in version 1.5.1.
  */
 #define kOfxImageEffectPropThumbnailRender "OfxImageEffectPropThumbnailRender"
 
diff --git a/readme.md b/readme.md
@@ -51,6 +51,9 @@ See instructions in [Documentation/README.md](Documentation/README.md).
 ## Pre-release
 
 * Update the release notes and documentation and version number
+  * Update [release-notes.md](./release-notes.md) and [release-notes-next.md](./release-notes-next.md)
+  * Update [include/ofx.doxy](include/ofx.doxy)
+  * Update [Documentation/sources/conf.py](Documentation/sources/conf.py)
 * Tag (locally) the desired version with e.g. `OFX_Release_1.x_pre_1`
    - use `git tag -a -s` to sign with the release gpg key
 * Push that tag to github, and email everyone to test that tagged build.
diff --git a/release-notes-next.md b/release-notes-next.md
@@ -0,0 +1,18 @@
+<!--
+This is a temporary space to hold changes and release notes for the next release.
+When preparing a release, copy this into the release-notes.md and reset this to empty.
+
+-->
+
+# Release Notes - NEXT (upcoming)
+
+This is version NEXT of the OpenFX API.
+
+## Key Features of OpenFX Version NEXT:
+
+## Fixes in OpenFX Version NEXT:
+
+## Deprecations
+
+## Detailed List of Changes
+
diff --git a/release-notes.md b/release-notes.md
@@ -1,6 +1,6 @@
 # OpenFX image processing plug-in API
 
-This is the latest release of OFX, the Open Effects image-processing plug-in standard API.
+This is the release 1.5.1 of OFX, the Open Effects image-processing plug-in standard API.
 
 Documentation and more info can be found at:
 
@@ -11,18 +11,6 @@ Documentation and more info can be found at:
 * [OFX API Programming Reference](http://openeffects.org/documentation/reference)
 * [OFX Discussion Google Group](https://groups.google.com/forum/#!forum/ofx-discussion)
 
-# Release Notes - 1.6 (upcoming)
-
-This is version 1.6 of the OpenFX API.
-
-## Key Features of OpenFX Version 1.6:
-
-## Fixes in OpenFX Version 1.6:
-
-## Deprecations
-
-## Detailed List of Changes
-
 # Release Notes - 1.5.1
 
 This is version 1.5.1 of the OpenFX API, a minor release with bug fixes and improvements.
