Skip to content

Commit 6bc66e9

Browse files
committed
regenerate release notes from jira query using ./modules/release-notes/single-source-release-notes.py
Signed-off-by: Nick Boldt <[email protected]>
1 parent f9b32a7 commit 6bc66e9

File tree

4 files changed

+100
-95
lines changed

4 files changed

+100
-95
lines changed

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

Lines changed: 72 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -16,78 +16,78 @@ Prom-client metrics have been removed and replaced with OpenTelemetry metrics. A
1616
[id="removed-functionality-rhidp-4853"]
1717
== Plugins with updated scope
1818

19-
To upgrade from {product-very-short} 1.3 to 1.4, you must update your configuration to use the latest versions of the following plugins from the new scope.
20-
21-
With this update, the following plugins, previously under the `@janus-idp` scope, have now been moved to the `@backstage-community` scope:
22-
23-
[cols=2,%header]
24-
|===
25-
| *RHDH 1.3 Plugin Name*
26-
| *RHDH 1.4 Plugin Name*
27-
|`@janus-idp/backstage-plugin-acr`|`@backstage-community/plugin-acr`
28-
|`@janus-idp/backstage-plugin-acr`|`@backstage-community/plugin-acr`
29-
|`@janus-idp/backstage-plugin-analytics-provider-segment`|`@backstage-community/plugin-analytics-provider-segment`
30-
|`@janus-idp/backstage-plugin-jfrog-artifactory`|`@backstage-community/plugin-jfrog-artifactory`
31-
|`@janus-idp/backstage-plugin-keycloak-backend`|`@backstage-community/plugin-catalog-backend-module-keycloak`
32-
|`@janus-idp/backstage-plugin-nexus-repository-manager`|`@backstage-community/plugin-nexus-repository-manager`
33-
|`@janus-idp/backstage-plugin-ocm`|`@backstage-community/plugin-ocm`
34-
|`@janus-idp/backstage-plugin-ocm-backend`|`@backstage-community/plugin-ocm-backend`
35-
|`@janus-idp/backstage-plugin-quay`|`@backstage-community/plugin-quay`
36-
|`@janus-idp/backstage-plugin-rbac`|`@backstage-community/plugin-rbac`
37-
|`@janus-idp/backstage-plugin-tekton`|`@backstage-community/plugin-tekton`
38-
|`@janus-idp/backstage-plugin-topology`|`@backstage-community/plugin-topology`
39-
|`@janus-idp/backstage-scaffolder-backend-module-quay`|`@backstage-community/plugin-scaffolder-backend-module-quay`
40-
|`@janus-idp/backstage-scaffolder-backend-module-regex`|`@backstage-community/plugin-scaffolder-backend-module-regex`
41-
|`@janus-idp/backstage-scaffolder-backend-module-servicenow`|`@backstage-community/plugin-scaffolder-backend-module-servicenow`
42-
|`@janus-idp/backstage-scaffolder-backend-module-sonarqube`|`@backstage-community/plugin-scaffolder-backend-module-sonarqube`
43-
|===
44-
45-
The following plugins, previously under the `@backstage` scope, have now been moved to the `@backstage-community` scope:
46-
[cols=2,%header]
47-
|===
48-
| *RHDH 1.3 Plugin Name*
49-
| *RHDH 1.4 Plugin Name*
50-
|`@backstage/plugin-azure-devops`|`@backstage-community/plugin-azure-devops`
51-
|`@backstage/plugin-azure-devops-backend`|`@backstage-community/plugin-azure-devops-backend`
52-
|`@backstage/plugin-dynatrace`|`@backstage-community/plugin-dynatrace`
53-
|`@backstage/plugin-github-actions`|`@backstage-community/plugin-github-actions`
54-
|`@backstage/plugin-github-issues`|`@backstage-community/plugin-github-issues`
55-
|`@backstage/plugin-jenkins`|`@backstage-community/plugin-jenkins`
56-
|`@backstage/plugin-jenkins-backend`|`@backstage-community/plugin-jenkins-backend`
57-
|`@backstage/plugin-lighthouse`|`@backstage-community/plugin-lighthouse`
58-
|`@backstage/plugin-sonarqube`|`@backstage-community/plugin-sonarqube`
59-
|`@backstage/plugin-sonarqube-backend`|`@backstage-community/plugin-sonarqube-backend`
60-
|`@backstage/plugin-tech-radar`|`@backstage-community/plugin-tech-radar`
61-
|===
62-
63-
Two plugins previously under the `@janus-idp` scope have moved to `@red-hat-developer-hub` scope:
64-
65-
[cols=2,%header]
66-
|===
67-
| *RHDH 1.3 Plugin Name*
68-
| *RHDH 1.4 Plugin Name*
69-
70-
| `@janus-idp/backstage-plugin-bulk-import`
71-
| `@red-hat-developer-hub/backstage-plugin-bulk-import`
72-
73-
| `@janus-idp/backstage-plugin-bulk-import-backend`
74-
| `@red-hat-developer-hub/backstage-plugin-bulk-import-backend`
75-
|===
76-
77-
With the update to the plugin scope, the dynamic plugin configuration has also been modified.
78-
79-
[cols=2,%header]
80-
|===
81-
|*RHDH 1.3 Configuration*|*RHDH 1.4 Configuration*
82-
|link:https://github.com/janus-idp/backstage-showcase/blob/release-1.3/dynamic-plugins.default.yaml[dynamic-plugins.default.yaml]|link:https://github.com/janus-idp/backstage-showcase/blob/release-1.4/dynamic-plugins.default.yaml[dynamic-plugins.default.yaml]
83-
|===
84-
85-
.Procedure
86-
* To upgrade from {product-very-short} 1.3 to {product-very-short} 1.4, you must update your configuration to use the latest versions of the plugins listed previously from the new scope.
87-
88-
[NOTE]
89-
====
90-
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.
19+
To upgrade from {product-very-short} 1.3 to 1.4, you must update your configuration to use the latest versions of the following plugins from the new scope.
20+
21+
With this update, the following plugins, previously under the `@janus-idp` scope, have now been moved to the `@backstage-community` scope:
22+
23+
[cols=2,%header]
24+
|===
25+
| *RHDH 1.3 Plugin Name*
26+
| *RHDH 1.4 Plugin Name*
27+
|`@janus-idp/backstage-plugin-acr`|`@backstage-community/plugin-acr`
28+
|`@janus-idp/backstage-plugin-acr`|`@backstage-community/plugin-acr`
29+
|`@janus-idp/backstage-plugin-analytics-provider-segment`|`@backstage-community/plugin-analytics-provider-segment`
30+
|`@janus-idp/backstage-plugin-jfrog-artifactory`|`@backstage-community/plugin-jfrog-artifactory`
31+
|`@janus-idp/backstage-plugin-keycloak-backend`|`@backstage-community/plugin-catalog-backend-module-keycloak`
32+
|`@janus-idp/backstage-plugin-nexus-repository-manager`|`@backstage-community/plugin-nexus-repository-manager`
33+
|`@janus-idp/backstage-plugin-ocm`|`@backstage-community/plugin-ocm`
34+
|`@janus-idp/backstage-plugin-ocm-backend`|`@backstage-community/plugin-ocm-backend`
35+
|`@janus-idp/backstage-plugin-quay`|`@backstage-community/plugin-quay`
36+
|`@janus-idp/backstage-plugin-rbac`|`@backstage-community/plugin-rbac`
37+
|`@janus-idp/backstage-plugin-tekton`|`@backstage-community/plugin-tekton`
38+
|`@janus-idp/backstage-plugin-topology`|`@backstage-community/plugin-topology`
39+
|`@janus-idp/backstage-scaffolder-backend-module-quay`|`@backstage-community/plugin-scaffolder-backend-module-quay`
40+
|`@janus-idp/backstage-scaffolder-backend-module-regex`|`@backstage-community/plugin-scaffolder-backend-module-regex`
41+
|`@janus-idp/backstage-scaffolder-backend-module-servicenow`|`@backstage-community/plugin-scaffolder-backend-module-servicenow`
42+
|`@janus-idp/backstage-scaffolder-backend-module-sonarqube`|`@backstage-community/plugin-scaffolder-backend-module-sonarqube`
43+
|===
44+
45+
The following plugins, previously under the `@backstage` scope, have now been moved to the `@backstage-community` scope:
46+
[cols=2,%header]
47+
|===
48+
| *RHDH 1.3 Plugin Name*
49+
| *RHDH 1.4 Plugin Name*
50+
|`@backstage/plugin-azure-devops`|`@backstage-community/plugin-azure-devops`
51+
|`@backstage/plugin-azure-devops-backend`|`@backstage-community/plugin-azure-devops-backend`
52+
|`@backstage/plugin-dynatrace`|`@backstage-community/plugin-dynatrace`
53+
|`@backstage/plugin-github-actions`|`@backstage-community/plugin-github-actions`
54+
|`@backstage/plugin-github-issues`|`@backstage-community/plugin-github-issues`
55+
|`@backstage/plugin-jenkins`|`@backstage-community/plugin-jenkins`
56+
|`@backstage/plugin-jenkins-backend`|`@backstage-community/plugin-jenkins-backend`
57+
|`@backstage/plugin-lighthouse`|`@backstage-community/plugin-lighthouse`
58+
|`@backstage/plugin-sonarqube`|`@backstage-community/plugin-sonarqube`
59+
|`@backstage/plugin-sonarqube-backend`|`@backstage-community/plugin-sonarqube-backend`
60+
|`@backstage/plugin-tech-radar`|`@backstage-community/plugin-tech-radar`
61+
|===
62+
63+
Two plugins previously under the `@janus-idp` scope have moved to `@red-hat-developer-hub` scope:
64+
65+
[cols=2,%header]
66+
|===
67+
| *RHDH 1.3 Plugin Name*
68+
| *RHDH 1.4 Plugin Name*
69+
70+
| `@janus-idp/backstage-plugin-bulk-import`
71+
| `@red-hat-developer-hub/backstage-plugin-bulk-import`
72+
73+
| `@janus-idp/backstage-plugin-bulk-import-backend`
74+
| `@red-hat-developer-hub/backstage-plugin-bulk-import-backend`
75+
|===
76+
77+
With the update to the plugin scope, the dynamic plugin configuration has also been modified.
78+
79+
[cols=2,%header]
80+
|===
81+
|*RHDH 1.3 Configuration*|*RHDH 1.4 Configuration*
82+
|link:https://github.com/janus-idp/backstage-showcase/blob/release-1.3/dynamic-plugins.default.yaml[dynamic-plugins.default.yaml]|link:https://github.com/janus-idp/backstage-showcase/blob/release-1.4/dynamic-plugins.default.yaml[dynamic-plugins.default.yaml]
83+
|===
84+
85+
.Procedure
86+
* To upgrade from {product-very-short} 1.3 to {product-very-short} 1.4, you must update your configuration to use the latest versions of the plugins listed previously from the new scope.
87+
88+
[NOTE]
89+
====
90+
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.
9191
====
9292

9393

modules/release-notes/ref-release-notes-deprecated-functionalities.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic` plug
1616
[id="deprecated-functionality-rhidp-4913"]
1717
== Audit log rotation is deprecated
1818

19-
With this update, you can evaluate your platform's log forwarding solutions to align with your security and compliance needs. Most of these solutions offer configurable options to minimize the loss of logs in the event of an outage.
19+
With this update, you can evaluate your platform&#39;s log forwarding solutions to align with your security and compliance needs. Most of these solutions offer configurable options to minimize the loss of logs in the event of an outage.
2020

2121

2222
.Additional resources

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

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ This section lists known issues in {product} {product-version}.
99

1010
Currently, when deploying {product-short} using the Helm Chart, two replicas cannot run on different cluster nodes. This might also affect the upgrade from 1.3 to 1.4.0 if the new pod is scheduled on a different node.
1111

12-
A possible workaround for the upgrade is to manually scale down the number of replicas to 0 before upgrading your Helm release. Or manually remove the old {product-short} pod after upgrading the Helm release. However, this would imply some application downtime. You can also leverage a Pod Affinity rule to force the cluster scheduler to run your {product-short} pods on the same node.
12+
Possible workarounds for the upgrade include the following actions:
13+
* Manually scale down the number of replicas to 0 before upgrading your Helm release.
14+
* Manually remove the old {product-short} pod after upgrading the Helm release. However, this would imply some application downtime.
15+
* Leverage a Pod Affinity rule to force the cluster scheduler to run your {product-short} pods on the same node.
1316

1417

1518
.Additional resources
@@ -18,11 +21,12 @@ A possible workaround for the upgrade is to manually scale down the number of re
1821
[id="known-issue-rhidp-5342"]
1922
== [Helm] Cannot run two RHDH replicas on different nodes due to Multi-Attach errors on the dynamic plugins root PVC
2023

21-
If you are deploying {product-short} using the Helm Chart, it is currently impossible to have 2 replicas running on different cluster nodes. This might also affect the upgrade from 1.3 to 1.4.0 if the new pod is scheduled on a different node.
24+
Currently, when deploying {product-short} using the Helm Chart, two replicas cannot run on different cluster nodes. This might also affect the upgrade from 1.3 to 1.4.0 if the new pod is scheduled on a different node.
2225

23-
A possible workaround for the upgrade is to manually scale down the number of replicas to 0 before upgrading your Helm release. Or manually remove the old {product-short} pod after upgrading the Helm release. However, this would imply some application downtime.
24-
You can also leverage a Pod Affinity rule to force the cluster scheduler to run your {product-short} pods on the same node.
25-
26+
Possible workarounds for the upgrade include the following actions:
27+
* Manually scale down the number of replicas to 0 before upgrading your Helm release.
28+
* Manually remove the old {product-short} pod after upgrading the Helm release. However, this would imply some application downtime.
29+
* Leverage a Pod Affinity rule to force the cluster scheduler to run your {product-short} pods on the same node.
2630

2731

2832
.Additional resources

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

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This section highlights new features in {product} {product-version}.
77
[id="enhancement-rhidp-2200"]
88
== Added an individual `mountPath`
99

10-
This update adds an individual `mountPath` for link:{configuring-book-url}#proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator[extra ConfigMaps or Secrets].
10+
This update adds an additional individual `mountPath` for extra configmaps or secrets.
1111

1212
[id="feature-rhidp-3621"]
1313
== `PersistentVolumeClaims` support is available
@@ -27,25 +27,26 @@ This update removes the `kube-rbac-proxy` sidecar container from the RHDH Operat
2727
[id="feature-rhidp-4414"]
2828
== Identifying Backstage flavor for plugins by using the `developerHub.flavor` field
2929

30-
With this update, you can use the `developerHub.flavor` field to identify whether plugins are running on {product-very-short}, {rhtap-very-short}, or vanilla Backstage, as shown in the following example:
31-
32-
.`app-config.yaml` fragment with the `developerhub.flavor` field
33-
34-
[source,yaml,subs="+quotes"]
35-
----
36-
developerHub:
37-
flavor: <flavor>
38-
----
39-
40-
`flavor`::
41-
Identify the flavor of Backstage that is running. Default value: `rhdh`
30+
With this update, you can use the `developerHub.flavor` field to identify whether plugins are running on {product-very-short}, {rhtap-very-short}, or vanilla Backstage, as shown in the following example:
31+
32+
.`app-config.yaml` fragment with the `developerhub.flavor` field
33+
34+
[source,yaml,subs=&#34;quotes&#34;]
35+
----
36+
developerHub:
37+
flavor: &lt;flavor&gt;;
38+
----
39+
40+
`flavor`::
41+
Identify the flavor of Backstage that is running. Default value: `rhdh`
4242

4343

4444
[id="feature-rhidp-4419"]
4545
== Ability to manage Persistent Volume Claim (PVCs) in {product-very-short} Operator
4646

47-
You can now mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field, while configuring RHDH Operator.
48-
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring/index#configuring-the-deployment[Configuring {product} deployment when using the Operator].
47+
You can now mount directories from pre-created PersistentVolumeClaims (PVCs) using the `spec.application.extraFiles.pvcs` field, while configuring RHDH Operator.
48+
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)].
49+
4950

5051
[id="feature-rhidp-4805"]
5152
== Authenticating with {rhbk-brand-name}
@@ -55,8 +56,8 @@ With this update, you can use {rhbk-brand-name} as an authentication provider. T
5556
[id="feature-rhidp-4806"]
5657
== Ability to install third-party plugins in {product-very-short}
5758

58-
You can now install third-party plugins in {product} without rebuilding the {product-very-short} application.
59-
59+
You can now install third-party plugins in {product} without rebuilding the {product-very-short} application.
60+
6061
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#assembly-install-third-party-plugins-rhdh[Installing third-party plugins in {product}].
6162

6263
[id="feature-rhidp-5156"]

0 commit comments

Comments
 (0)