From 994b0ee505cbe4eedf7dc4327d10f1cc5d311994 Mon Sep 17 00:00:00 2001 From: deerskindoll Date: Thu, 10 Jul 2025 10:13:19 +0200 Subject: [PATCH] RHDEVDOCS-6488 feedback feedback Update modules/ob-release-notes-1-5.adoc Co-authored-by: Avinal Kumar Update modules/ob-release-notes-1-5.adoc Co-authored-by: Avinal Kumar Update modules/ob-release-notes-1-5.adoc Co-authored-by: Avinal Kumar Update modules/ob-release-notes-1-5.adoc Co-authored-by: Lisa Pettyjohn Update modules/ob-release-notes-1-5.adoc Co-authored-by: Lisa Pettyjohn feedback --- modules/ob-compatibility-support-matrix.adoc | 5 +- modules/ob-release-notes-1-0.adoc | 46 -------------- modules/ob-release-notes-1-1.adoc | 42 ------------- modules/ob-release-notes-1-2.adoc | 24 -------- modules/ob-release-notes-1-5.adoc | 65 ++++++++++++++++++++ release_notes/ob-release-notes.adoc | 2 +- 6 files changed, 68 insertions(+), 116 deletions(-) delete mode 100644 modules/ob-release-notes-1-0.adoc delete mode 100644 modules/ob-release-notes-1-1.adoc delete mode 100644 modules/ob-release-notes-1-2.adoc create mode 100644 modules/ob-release-notes-1-5.adoc diff --git a/modules/ob-compatibility-support-matrix.adoc b/modules/ob-compatibility-support-matrix.adoc index fdf0fdb6940d..8595f98db9c7 100644 --- a/modules/ob-compatibility-support-matrix.adoc +++ b/modules/ob-compatibility-support-matrix.adoc @@ -23,8 +23,7 @@ The link:https://access.redhat.com/support/offerings/techpreview[Technology Prev | Operator | Builds (Shipwright) | CLI | | | -|1.1 | 0.13.0 (GA) | 0.13.0 (GA) | 1.13, 1.14, and 1.15 | 4.12, 4.13, 4.14, 4.15, and 4.16 | GA -|1.0 | 0.12.0 (GA) | 0.12.0 (GA) | 1.12, 1.13, 1.14, and 1.15 | 4.12, 4.13, 4.14, 4.15, and 4.16 | GA -|1.2 | | | | | GA +|1.5 | 0.16.0 (GA) | 0.16.0 (GA) | 1.17, 1.18, 1.19 and 1.20 | 4.16, 4.17, 4.18, and 4.19 | GA +|1.4 | 0.15.0 (GA) | 0.15.0 (GA) | 1.16, 1.17, 1.18 and 1.19 | 4.15, 4.16, 4.17, and 4.18 | GA |=== diff --git a/modules/ob-release-notes-1-0.adoc b/modules/ob-release-notes-1-0.adoc deleted file mode 100644 index 619c5eb62d8a..000000000000 --- a/modules/ob-release-notes-1-0.adoc +++ /dev/null @@ -1,46 +0,0 @@ -// This module is included in the following assemblies: -// * about/ob-release-notes.adoc - -:_mod-docs-content-type: REFERENCE -[id="ob-release-notes-1-0_{context}"] -= Release notes for {builds-shortname} General Availability 1.0 - -{builds-shortname} General Availability (GA) 1.0 is now available on {ocp-product-title} 4.14. - -[id="new-features-1-0_{context}"] -== New features - -The following sections highlight what is new in {builds-shortname} 1.0. - -[id="builds-new-features-1-0_{context}"] -=== Builds - -* This release supports the `buildah` and `source-to-image` build strategies. The {builds-operator} automatically installs these strategies for use. -+ -[NOTE] -==== -The `buildpacks` build strategy is currently in link:https://access.redhat.com/support/offerings/devpreview[Developer Preview]. Red Hat plans to make this strategy generally available for use in a future release. -==== - -* With this release, you can define volume mounts in your `BuildStartegy` resource. When defining a strategy, you can declare volumes which can be shared across build steps and build runs. You can also declare the mount point for the volume which is fixed across all build steps. Volumes can either have a fixed volume source, or an overridable volume source that you can set in a `Build` or `BuildRun` resource. - -* With this release, you can embed a complete build specification into your `BuildRun` resource by using the `spec.build.spec` field. By embedding specifications, you can build an image without creating and maintaining a dedicated `Build` resource. - -* This release supports automated cleaning of completed build runs after a specific time or when a certain number of build runs is reached. By using retention parameters, you can specify the duration for which a completed build run can exist and the number of succeeded or failed build runs that can exist. - -* With this release, you can configure a build by defining the source, build strategy, parameter values, builder or docker file, output, retention parameters, and volumes in a `Build` resource. - -* With this release, you can configure a build strategy by defining strategy parameters, system parameters, step resources definitions, annotations, and volumes in a `BuildStrategy` or `ClusterBuildStrategy` resource. - -* With this release, you can configure a build run by defining the build reference, build specification, parameter values, service account, output, retention parameters, and volumes. - -* With this release, you can monitor your build resources by using build controller metrics. - -* With this release, you can add an annotation `build.shipwright.io/referenced.secret: "true"` to a build secret. Based on this annotation, the build controller takes a reconcile action when an event, such as create, update, or delete triggers for the build secret. - - -[id="cli-new-features-1-0_{context}"] -=== CLI - -* With this release, you can create, delete, list, or run a `Build` resource. -* With this release, you can create or list a `BuildRun` resource, or view its logs. \ No newline at end of file diff --git a/modules/ob-release-notes-1-1.adoc b/modules/ob-release-notes-1-1.adoc deleted file mode 100644 index 64741008ebeb..000000000000 --- a/modules/ob-release-notes-1-1.adoc +++ /dev/null @@ -1,42 +0,0 @@ -// This module is included in the following assemblies: -// * about/ob-release-notes.adoc - -:_mod-docs-content-type: REFERENCE -[id="ob-release-notes-1-1_{context}"] -= Release notes for {builds-shortname} General Availability 1.1 - -{builds-shortname} General Availability (GA) 1.1 is now available on {ocp-product-title} 4.16. - -[id="new-features-1-1_{context}"] -== New features - -The following sections highlight what is new in {builds-shortname} 1.1. - -[id="builds-new-features-1-1_{context}"] -=== Builds - -* The builds controllers now use Tekton's V1 API to create and access the `TaskRun` that backs a `BuildRun`. - -* With this release, you can now define a build without any source. This is useful if you want to run the build using only the local source. - -* The output image section now supports an optional timestamp field to change the image creation timestamp. Use the `SourceTimestamp` string to set it to match the source timestamp. - -* With this release, the `.source.type` field is now required in both `build` and `buildRun`. - -* With this release, the Operator now installs Shipwright by default and introduces several user experience enhancements for Builds. - - -[id="csi-driver-new-features-1-1_{context}"] -=== Shared Resource CSI Driver - -* The Shared Resource CSI Driver is now generally available. With this release, the CSI Shared Driver enables sharing of `ConfigMaps` and secrets across different namespaces in Kubernetes clusters. The driver has permission to read all Kubernetes secrets. This feature improves resource efficiency by reducing duplication and simplifies configuration management in multi-tenant environments. Administrators can define access policies to control which namespaces can read or modify these shared resources. - -[id="known-issues-1-1_{context}"] -== Known issues - -The following section highlights known issues in {builds-shortname} 1.1. - -[id="builds-known-issues-1-1_{context}"] -=== Builds - -* With this release, direct upgrades from Builds 1.0 to Builds 1.1 are not supported. To upgrade to Builds 1.1, you must delete the `ShipwrightBuild` object, uninstall the Builds `1.0.z` operator, and then install the Builds `1.1.0` operator from OperatorHub. \ No newline at end of file diff --git a/modules/ob-release-notes-1-2.adoc b/modules/ob-release-notes-1-2.adoc deleted file mode 100644 index 1b8e029f02d8..000000000000 --- a/modules/ob-release-notes-1-2.adoc +++ /dev/null @@ -1,24 +0,0 @@ -// This module is included in the following assemblies: -// * about/ob-release-notes.adoc - -:_mod-docs-content-type: REFERENCE -[id="ob-release-notes-1-2_{context}"] -= Release notes for {builds-shortname} General Availability 1.2 - -{builds-shortname} General Availability (GA) 1.2 is now available on {ocp-product-title} . - -[id="new-features-1-2_{context}"] -== New features - -The following sections highlight what is new in {builds-shortname} 1.2. - -[id="builds-new-features-1-1_{context}"] -=== Builds - - -[id="known-issues-1-2_{context}"] -== Known issues - -The following section highlights known issues in {builds-shortname} 1.2. - - diff --git a/modules/ob-release-notes-1-5.adoc b/modules/ob-release-notes-1-5.adoc new file mode 100644 index 000000000000..ed813e3a4757 --- /dev/null +++ b/modules/ob-release-notes-1-5.adoc @@ -0,0 +1,65 @@ +// This module is included in the following assemblies: +// * about/ob-release-notes.adoc + +:_mod-docs-content-type: REFERENCE +[id="ob-release-notes-1-5_{context}"] += Release notes for {builds-shortname} 1.5 + +{builds-shortname} 1.5 is now available on {ocp-product-title} 4.16, 4.17, 4.18, and 4.19. + +[id="new-features-1-5_{context}"] +== New features + +The following sections highlight what is new in {builds-shortname} 1.5. + +* With this update, {builds-operator} deploys Shipwright v0.16 components. +* With this update, you can use the optional `.spec.nodeSelector` value with `shp` CLI to specify which nodes build run pods should run on. +* With this update, you can use the optional `--scheduler-name` flag with `shp` CLI to specify the scheduler to use for scheduling build run pods. +* With this update, two buildpacks `ClusterBuildStrategy` options are available for {builds-shortname}: ++ +** `buildpacks` strategy +** `buildpacks-extender` strategy ++ +[NOTE] +==== +The `buildpacks-extender` strategy is compatible with the experimental buildpacks `extender` lifecycle phase. You can use this strategy, for example, for builds based on Node.js. However, the `extender` phase does not support Quarkus, or any other Java-based builds. For such builds, use the `buildpacks` strategy instead. +==== ++ +Both strategies introduce new features, enhance compliance with Cloud Native Buildpacks (CNB) 0.12 specifications, and improve the overall stability and usability of the buildpacks `ClusterBuildStrategy`. ++ +[IMPORTANT] +==== +Buildpacks is a Technology Preview feature only. Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete. Red{nbsp}Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. + +For more information about the support scope of Red{nbsp}Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. +==== +* With this update, +the `source.git.depth` parameter was added to the `Build` resource to specify the depth of the Git history. +The default value is 1 and no history is cloned. +This is the fastest way to clone a Git repository +and is applicable for all cases where your build logic doesn't rely on Git history. ++ +Any value greater than 1 will create a clone with the specified depth. For a full Git history clone, set the depth to 0. ++ +[NOTE] +==== +If you specify a commit SHA as a revision, the full history is always cloned before this commit is checked out. +==== + +[id="fixed-issues-1-5_{context}"] +== Fixed issues + +The following list highlights fixed issues in {builds-shortname} 1.5. + +* Before this update, the build controller had permission to modify `CustomResourceDefinitions`. This caused the controller to have excessive permissions, resulting in a minor security risk. With this update, the issue is fixed. +* Before this update, if the {builds-operator} failed to reconcile the `ShipwrightBuild` or the `SharedResource` objects, but the status update of the build controller succeeded, build controller was not requeued for reconciliation despite the previous failure. With this update, the issue is solved. + +[id="deprecated-features-1-5_{context}"] +== Deprecated features + +The following section highlights deprecated features in {builds-shortname} 1.5. + +* With this update, the following channels are deprecated: +** builds-1.3 + +Instead, use the builds-1.5 channel. \ No newline at end of file diff --git a/release_notes/ob-release-notes.adoc b/release_notes/ob-release-notes.adoc index 72b4e65c60e4..5898934109f3 100644 --- a/release_notes/ob-release-notes.adoc +++ b/release_notes/ob-release-notes.adoc @@ -27,4 +27,4 @@ include::modules/ob-compatibility-support-matrix.adoc[leveloffset=+1] // Modules included, most to least recent -include::modules/ob-release-notes-1-2.adoc[leveloffset=+1] +include::modules/ob-release-notes-1-5.adoc[leveloffset=+1]