chore: release notes for 1.4.1 (replace custom/manual content with JIRA-driven RN content too) #848

nickboldt · 2025-01-14T01:57:48Z

What does this PR do?

chore: release notes for 1.4.1 (replace custom/manual content with JIRA-driven RN content too)
Signed-off-by: Nick Boldt [email protected]

Screenshot/screencast of this PR

N/A

What issues does this PR fix or reference?

https://issues.redhat.com/browse/RHIDP-5521
https://issues.redhat.com/browse/RHIDP-5525

How to test this PR?

N/A

PR Checklist

As the author of this Pull Request I made sure that:

Code produced is complete
Code builds without errors
Tests are covering the bugfix
Relevant user documentation updated
Relevant contributing documentation updated

Reviewers

Reviewers, please comment how you tested the PR when approving it.

rhdh-bot · 2025-01-14T03:08:37Z

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-848/ @ 01/17/25 17:35:41

nickboldt · 2025-01-14T03:15:13Z

modules/release-notes/ref-release-notes-known-issues.adoc

@@ -4,21 +4,28 @@

 This section lists known issues in {product} {product-version}.

-[id="known-issue-rhidp-3396"]


reordered content to be in number-sorted

nickboldt · 2025-01-14T03:15:35Z

modules/release-notes/ref-release-notes-new-features.adoc

-You can now mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field, while configuring RHDH Operator.
-For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html-single/administration_guide_for_red_hat_developer_hub/index#proc-rhdh-deployment-config_assembly-admin-templates[Persistent Volume Claim (PVC)].
+You can now mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field, while configuring RHDH Operator.
+For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/configuring/index#configuring-the-deployment[Persistent Volume Claim (PVC)].


fixed link to 1.4 docs

nickboldt · 2025-01-14T03:15:58Z

modules/release-notes/ref-release-notes-new-features.adoc

-You can now install third-party plugins in {product} without rebuilding the {product-very-short} application.
-
-For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html-single/introduction_to_plugins/index[Third party plugins].
+== Ability to install third-party plugins in RHDH


consumed from JIRA so better to use RHDH than the attribute here

nickboldt · 2025-01-14T03:16:22Z

modules/release-notes/ref-release-notes-technology-preview.adoc

+See: link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview support scope].
+====
+
+[id="technology-preview-rhidp-5545"]


manually added content replaced by jira-derived RN content

nickboldt · 2025-01-14T03:16:50Z

modules/release-notes/single-source-fixed-security-issues.sh

@@ -14,40 +14,39 @@
 set -e

 # get the z-stream version from the bundle-version attribute. Note that while chart-version could be larger, this is the correct value for CVE tracking
-product_version="$(grep ':product-bundle-version:' artifacts/attributes.adoc | cut -d' ' -f2 )"


updated script from updates done for 1.3.3, ported here.

modules/release-notes/single-source-release-notes-template.adoc.jinja

nickboldt · 2025-01-14T03:17:36Z

modules/release-notes/single-source-release-notes.jira2asciidoc.yml

@@ -13,7 +13,7 @@ sections:
      AND status in (Closed, "Release Pending")
      AND "Release Note Type" in ("Feature", "Enhancement")
      AND fixVersion >= "{version_minor}"
-      AND fixVersion <= "{version_patch}"
+      AND fixVersion < "{version_next}"


this is better so that we don't have to move things to an arbitrary 1.4.z version for Known Issues

nickboldt · 2025-01-14T03:18:39Z

modules/release-notes/ref-release-notes-breaking-changes.adoc

-[NOTE]
-====
-In addition to the previously provided tables, you can compare the link:https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/blob/release-1.4/modules/dynamic-plugins/rhdh-supported-plugins.csv[RHDH 1.4 CSV file] with the link:https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/blob/release-1.3/modules/dynamic-plugins/rhdh-supported-plugins.csv[RHDH 1.3 CSV file] to identify the changes in dynamic plugins.
+[id="removed-functionality-rhidp-4853"]


the breaking change section is driven by JIRA Release Notes Type = "Removed Functionality", not "Feature"

Gerry-Forde

@nickboldt I've reviewed this content and left some suggestions.

nickboldt · 2025-01-16T13:04:07Z

Changes applied in the python script to add back the empty lines, and applied all your RN copy changes in the JIRAs where the content comes from.

In future please make edits in JIRA since that is the singel source of truth for RN content.

LMK if I missed anything or if the update is ready to merge. Thanks!

themr0c · 2025-01-16T13:46:13Z

Awesome! Thank you!

changes applied

Signed-off-by: Nick Boldt <[email protected]> fix queries Signed-off-by: Nick Boldt <[email protected]> put content in JIRA instead of overriding content after generation Signed-off-by: Nick Boldt <[email protected]> put back deleted content (why do people keep forgetting to put RN content in JIRA?) Signed-off-by: Nick Boldt <[email protected]> regen from jira Signed-off-by: Nick Boldt <[email protected]> regen more Signed-off-by: Nick Boldt <[email protected]> Remove empty lines Signed-off-by: Nick Boldt <[email protected]>

Signed-off-by: Nick Boldt <[email protected]> add CVE-2024-56334 to snip-fixed-security-issues-in-product-1.4.1.adoc Signed-off-by: Nick Boldt <[email protected]> add spaces back into the generated RN Signed-off-by: Nick Boldt <[email protected]> more fixes from JIRA updates Signed-off-by: Nick Boldt <[email protected]>

nickboldt · 2025-01-16T18:07:35Z

Added 3 missing RN items that were fixed in this release but which didn't have the Release Note Status = Done.

…use Release Note Status was not set to Done Signed-off-by: Nick Boldt <[email protected]> remove dupe RN issue (https://issues.redhat.com/browse/RHIDP-5319 is a subset of https://issues.redhat.com/browse/RHIDP-5308; some reformatting and language cleanup Signed-off-by: Nick Boldt <[email protected]>

Gerry-Forde · 2025-01-19T21:56:56Z

modules/release-notes/ref-release-notes-fixed-issues.adoc

+=== Updating Channel does not trigger an Operator Update
+
+Administrators may encounter problems updating {product-short} across channels. As a workaround, to upgrade across channels:
+
+* Delete the {product-very-short} operator subscription (but not its operands)
+* Create a new subscription pointing to the new channel (`fast` or `fast-1.4`), using the latest CSV
+* Once installed, any existing Backstage objects will be upgraded through the new operator
+
+Note, your app config may need to be adjusted as part of the rollout, if plugins have changed their name or configuration requirements. See link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/release_notes/index#feature-rhidp-4853[Plugins with updated scope]. 
+
+


Suggested change

=== Updating Channel does not trigger an Operator Update

Administrators may encounter problems updating {product-short} across channels. As a workaround, to upgrade across channels:

* Delete the {product-very-short} operator subscription (but not its operands)

* Create a new subscription pointing to the new channel (`fast` or `fast-1.4`), using the latest CSV

* Once installed, any existing Backstage objects will be upgraded through the new operator

Note, your app config may need to be adjusted as part of the rollout, if plugins have changed their name or configuration requirements. See link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/release_notes/index#feature-rhidp-4853[Plugins with updated scope].

=== Updating Channel does not trigger an Operator update

Administrators may encounter problems updating {product-short} across channels. As a workaround, to upgrade across channels:

* Delete the {product-very-short} Operator subscription. Do not delete the operands.

* Create a new subscription pointing to the new channel (`fast` or `fast-1.4`), using the latest CSV.

* When you install the new operator, the existing Backstage objects will be upgraded.

[NOTE]

If plugin names or configuration requirements have been changed, you may need to update your application configuration. See link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/release_notes/index#feature-rhidp-4853[Plugins with updated scope].

I realize that this content is taken directly from the associated Jira, so I've edited the Jira RN Text to mirror this suggestion .

Gerry-Forde · 2025-01-19T22:00:46Z

modules/release-notes/ref-release-notes-fixed-issues.adoc

+[id="bug-fix-rhidp-5308"]
+=== notification backend and catalog backend gitlab org failing to load with MODULE_NOT_FOUND
+
+In the previous version of {product-short}, the gitlab org catalog backend plugin and notification backend plugin would fail to load when configured with a `MODULE_NOT_FOUND` error.  This has been fixed by embedding the  missing dependencies in the dynamic plugins.


Suggested change

In the previous version of {product-short}, the gitlab org catalog backend plugin and notification backend plugin would fail to load when configured with a `MODULE_NOT_FOUND` error. This has been fixed by embedding the missing dependencies in the dynamic plugins.

In the previous version of {product-short}, the GitLab Org catalog backend plugin (`plugin-catalog-backend-module-gitlab-org`)and the Notification backend plugin (`plugin-notifications-backend`) fail to load when configured with a `MODULE_NOT_FOUND` error. This has been fixed by embedding the missing dependencies in the dynamic plugins.

This suggestion has also been updated in the Jira RN Text field.

Gerry-Forde

@nickboldt I've reviewed your latest commit changes and left a couple of suggestions.

nickboldt temporarily deployed to internal January 14, 2025 01:57 — with GitHub Actions Inactive

nickboldt temporarily deployed to internal January 14, 2025 01:59 — with GitHub Actions Inactive

nickboldt temporarily deployed to internal January 14, 2025 02:19 — with GitHub Actions Inactive

nickboldt temporarily deployed to internal January 14, 2025 02:33 — with GitHub Actions Inactive

nickboldt force-pushed the RHIDP-5521 branch from dbba029 to acbb3b1 Compare January 14, 2025 03:06

nickboldt temporarily deployed to internal January 14, 2025 03:06 — with GitHub Actions Inactive

nickboldt force-pushed the RHIDP-5521 branch from acbb3b1 to 9947d5d Compare January 14, 2025 03:14

nickboldt temporarily deployed to internal January 14, 2025 03:14 — with GitHub Actions Inactive

nickboldt commented Jan 14, 2025

View reviewed changes

modules/release-notes/single-source-release-notes-template.adoc.jinja Outdated Show resolved Hide resolved

nickboldt commented Jan 14, 2025

View reviewed changes

nickboldt changed the title ~~chore: release notes for 1.4.1 (removing...~~ chore: release notes for 1.4.1 (replace custom/manual content with JIRA-driven RN content too) Jan 14, 2025

nickboldt requested review from Gerry-Forde, jmagak and themr0c January 14, 2025 03:19

nickboldt mentioned this pull request Jan 14, 2025

chore: update Dynamic Plugins versions for RHDH 1.4 redhat-developer/rhdh#2139

Open

nickboldt marked this pull request as draft January 14, 2025 20:09

openshift-ci bot added the do-not-merge/work-in-progress label Jan 14, 2025

nickboldt force-pushed the RHIDP-5521 branch from 9947d5d to f7f017c Compare January 15, 2025 15:47

nickboldt temporarily deployed to internal January 15, 2025 15:47 — with GitHub Actions Inactive

nickboldt marked this pull request as ready for review January 15, 2025 15:48

openshift-ci bot removed the do-not-merge/work-in-progress label Jan 15, 2025

nickboldt temporarily deployed to internal January 15, 2025 15:49 — with GitHub Actions Inactive

nickboldt force-pushed the RHIDP-5521 branch from f7f017c to b6117b9 Compare January 15, 2025 15:51

Gerry-Forde previously requested changes Jan 15, 2025

View reviewed changes

nickboldt temporarily deployed to internal January 16, 2025 12:38 — with GitHub Actions Inactive

nickboldt temporarily deployed to internal January 16, 2025 12:54 — with GitHub Actions Inactive

nickboldt requested a review from Gerry-Forde January 16, 2025 13:03

themr0c approved these changes Jan 16, 2025

View reviewed changes

nickboldt added SME review done ⛅ Peer review done 📘 labels Jan 16, 2025

nickboldt temporarily deployed to internal January 16, 2025 17:56 — with GitHub Actions Inactive

nickboldt added Peer review needed 📖 SME review needed 🔩 and removed SME review done ⛅ Peer review done 📘 labels Jan 16, 2025

nickboldt temporarily deployed to internal January 16, 2025 18:06 — with GitHub Actions Inactive

nickboldt added 2 commits January 16, 2025 13:06

nickboldt force-pushed the RHIDP-5521 branch from a49bc89 to 9d4caf5 Compare January 16, 2025 18:06

nickboldt requested a review from themr0c January 16, 2025 18:06

nickboldt temporarily deployed to internal January 16, 2025 18:06 — with GitHub Actions Inactive

nickboldt force-pushed the RHIDP-5521 branch from 9d4caf5 to 550c551 Compare January 16, 2025 18:08

nickboldt temporarily deployed to internal January 16, 2025 18:08 — with GitHub Actions Inactive

Merge branch 'release-1.4' into RHIDP-5521

45d93e9

nickboldt temporarily deployed to internal January 17, 2025 17:33 — with GitHub Actions Inactive

Gerry-Forde reviewed Jan 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: release notes for 1.4.1 (replace custom/manual content with JIRA-driven RN content too) #848

chore: release notes for 1.4.1 (replace custom/manual content with JIRA-driven RN content too) #848

nickboldt commented Jan 14, 2025 •

edited

Loading

rhdh-bot commented Jan 14, 2025 •

edited

Loading

nickboldt Jan 14, 2025

nickboldt Jan 14, 2025

nickboldt Jan 14, 2025

nickboldt Jan 14, 2025

nickboldt Jan 14, 2025 •

edited

Loading

nickboldt Jan 14, 2025

nickboldt Jan 14, 2025

Gerry-Forde left a comment

nickboldt commented Jan 16, 2025

themr0c commented Jan 16, 2025

nickboldt commented Jan 16, 2025

Gerry-Forde Jan 19, 2025

Gerry-Forde Jan 19, 2025

Gerry-Forde left a comment

		@@ -4,21 +4,28 @@

		This section lists known issues in {product} {product-version}.

		[id="known-issue-rhidp-3396"]

	In the previous version of {product-short}, the gitlab org catalog backend plugin and notification backend plugin would fail to load when configured with a `MODULE_NOT_FOUND` error. This has been fixed by embedding the missing dependencies in the dynamic plugins.
	In the previous version of {product-short}, the GitLab Org catalog backend plugin (`plugin-catalog-backend-module-gitlab-org`)and the Notification backend plugin (`plugin-notifications-backend`) fail to load when configured with a `MODULE_NOT_FOUND` error. This has been fixed by embedding the missing dependencies in the dynamic plugins.

chore: release notes for 1.4.1 (replace custom/manual content with JIRA-driven RN content too) #848

Are you sure you want to change the base?

chore: release notes for 1.4.1 (replace custom/manual content with JIRA-driven RN content too) #848

Conversation

nickboldt commented Jan 14, 2025 • edited Loading

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

PR Checklist

Reviewers

rhdh-bot commented Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nickboldt Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Gerry-Forde left a comment

Choose a reason for hiding this comment

nickboldt commented Jan 16, 2025

themr0c commented Jan 16, 2025

nickboldt commented Jan 16, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Gerry-Forde left a comment

Choose a reason for hiding this comment

nickboldt commented Jan 14, 2025 •

edited

Loading

rhdh-bot commented Jan 14, 2025 •

edited

Loading

nickboldt Jan 14, 2025 •

edited

Loading