Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release notes for Red Hat Developer Hub 1.4- Update Release Note Texts #758

Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
1014481
Update release note texts
jmagak Dec 2, 2024
e39d29b
Update release note texts
jmagak Dec 3, 2024
6541f1a
Update release note texts
jmagak Dec 4, 2024
5b3ca90
Update release note texts
jmagak Dec 5, 2024
59faaa3
Update release note texts
jmagak Dec 9, 2024
d42a2c1
Update release note texts
jmagak Dec 10, 2024
0676423
Update realease notes texts
jmagak Dec 10, 2024
5038b64
Update release note texts
jmagak Dec 13, 2024
120e440
Update release note texts
jmagak Dec 13, 2024
65d67d7
Updates RN content
jmagak Dec 13, 2024
761d15c
Updates RN content
jmagak Dec 13, 2024
1390df8
Updates RN content
jmagak Dec 13, 2024
2ab852e
Updates RN content
jmagak Dec 13, 2024
cbcffae
Update RN notes
invalid-email-address Dec 13, 2024
0a29a53
Latest RN texts
invalid-email-address Dec 13, 2024
3e7d2dc
Merge branch 'release-1.4' into RHIDP-4585-Release-Notes-1.4-Known-is…
jmagak Dec 13, 2024
89043a4
Latest RN texts
invalid-email-address Dec 13, 2024
8c4b4ec
Update RN suggestion
invalid-email-address Dec 16, 2024
3f5386e
Merge branch 'release-1.4' into RHIDP-4585-Release-Notes-1.4-Known-is…
jmagak Dec 16, 2024
fe8fbc4
Update release note texts
invalid-email-address Dec 16, 2024
d00ebf5
Merge branch 'release-1.4' into RHIDP-4585-Release-Notes-1.4-Known-is…
jmagak Dec 16, 2024
c53bff9
Fix RN texts
invalid-email-address Dec 16, 2024
75bbfcb
Merge branch 'release-1.4' into RHIDP-4585-Release-Notes-1.4-Known-is…
jmagak Dec 16, 2024
3248911
Update changes on RNs
invalid-email-address Dec 17, 2024
9a3d2cc
Merge branch 'release-1.4' into RHIDP-4585-Release-Notes-1.4-Known-is…
themr0c Dec 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions artifacts/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
:product-version: 1.4
:product-bundle-version: 1.4.0
:product-chart-version: 1.4.0
:product-backstage-version: 1.29.2
:product-backstage-version: 1.31.3
jmagak marked this conversation as resolved.
Show resolved Hide resolved
:product-custom-resource-type: Backstage
:rhdeveloper-name: Red Hat Developer
:rhel: Red Hat Enterprise Linux
Expand Down Expand Up @@ -46,7 +46,8 @@
:rhsso: RHSSO
:rhbk-brand-name: Red Hat Build of Keycloak
:rhbk: RHBK
:keycloak-version: 24.0
:rhtap-brand-name: Red Hat Trusted Application Pipeline
:rhtap-very-short: RHTAP

// Partner Platforms
:aws-brand-name: Amazon Web Services
Expand Down
71 changes: 0 additions & 71 deletions assemblies/assembly-release-notes-fixed-issues.adoc

This file was deleted.

20 changes: 0 additions & 20 deletions assemblies/assembly-release-notes-known-issues.adoc

This file was deleted.

8 changes: 8 additions & 0 deletions modules/release-notes/ref-release-notes-breaking-changes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,12 @@

This section lists breaking changes in {product} {product-version}.

[id="removed-functionality-rhidp-4572"]
== Updated monitoring and logging metrics

Prom-client metrics have been removed and replaced with OpenTelemetry metrics. As a result, the metrics port has changed from `7007` to `9464`. Deprecated metrics have also been removed. If you had dependencies on these, ensure your prometheus queries are updated. For further information, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html-single/monitoring_and_logging/index#assembly-rhdh-observability[Monitoring and logging]
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-4572[RHIDP-4572]



Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,20 @@
= Deprecated functionalities

This section lists deprecated functionalities in {product} {product-version}.

[id="deprecated-functionality-rhidp-3545"]
== `./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic` plugin is deprecated

The `./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic` plugin has been deprecated and will be removed in the next release. You can link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[use Ansible plug-ins for {product-very-short}] instead.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-3545[RHIDP-3545]

[id="deprecated-functionality-rhidp-4913"]
== Audit log rotation is deprecated

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.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-4913[RHIDP-4913]



156 changes: 156 additions & 0 deletions modules/release-notes/ref-release-notes-fixed-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,159 @@

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

== Fixed issues in 1.4

[id="bug-fix-rhidp-2727"]
=== GitHub issues plugin supports multiple GitHub integration hosts

Previously, the GitHub issues plugin defaulted to using the first GitHub integration it detected for all components. This behavior made it incompatible with setups involving multiple GitHub integration hosts.

Now, GitHub issues plugin supports multiple GitHub integration hosts. It uses the well-known entity slug annotation `backstage.io/source-location` or `backstage.io/managed-by-location` to determine the appropriate GitHub integration for a component. If no integration matches the slug, the first GitHub integration is selected, maintaining the previous behavior.

.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-2727[RHIDP-2727]


[id="bug-fix-rhidp-2903"]
=== All API documentation is defined in the 3scale backend plugin

Previously, some API documentation defined in the 3scale backend plugin was not accessible in {product-very-short}.

With this update, all API documentation defined in the 3scale backend plugin is imported and merged in the {product-very-short}.
.Additional resources
* link:https://issues.redhat.com/browse/RHIDP-2903[RHIDP-2903]


[id="bug-fix-rhidp-3115"]
=== {product-very-short} helm chart deployment throws `NotAllowedError`

Previously, when deploying with the Helm Chart, there could be a mismatch between the Route hostname and the `baseUrl` fields added to the generated app-config ConfigMap. This could sometimes cause failure to authenticate against some providers due to an origin mismatch.

This update fixes this issue by ensuring no mismatch between those values.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-3115[RHIDP-3115]


[id="bug-fix-rhidp-3849"]
=== Disable the creation of permission policies and roles when disabling the RBAC backend plugin

Previously, disabling the Role-Based Access Control (RBAC) backend plugin created roles and permission policies, whether the permission framework was enabled or not.

With this update, disabling the RBAC backend plugin no longer creates roles and permission policies.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-3849[RHIDP-3849]


[id="bug-fix-rhidp-3931"]
=== Added alert on the deletion icon during bulk imports

Before this update, repositories were added to the {product-short} from various sources, such as `app-config` files or GitHub discovery. The Bulk Import plugin only tracked repositories accessible using the configured GitHub integrations. When both plugins were enabled, repositories discovered by GitHub Discovery appeared on Bulk Import pages. However, deleting these repositories from Bulk Import Jobs had no effect, as entities from discovery or `app-config.yaml` file remained in the {product-short} catalog.

With this update, an alert on the deletion icon notifies the user to modify the source (either the `catalog-info` within the repository or the `app-config.yaml` file if the file originates from there) to remove the catalog entity.

.Additional resources
* link:https://issues.redhat.com/browse/RHIDP-3931[RHIDP-3931]


[id="bug-fix-rhidp-4240"]
=== Removed the pre-configured custom resources from the Kubernetes configuration

Before this update, the custom resources in Kubernetes configuration were pre-configured. As a result, users could see Tekton warnings without configuring the custom resources in Kubernetes.

This update removes the pre-configured custom resources from the Kubernetes configuration. Therefore, users can customize resources to the Kubernetes configuration based on their requirements, preventing unrelated warnings from appearing.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-4240[RHIDP-4240]


[id="bug-fix-rhidp-4241"]
=== RBAC Plugin is broken with latest Backstage version (`1.31`)

Before this update, Role-Based Access Control (RBAC) backend plugin broke in Backstage `1.31` with an error.

This update resolves compatibility issues with RBAC backend plugin on Backstage versions `1.31` and `1.32` without displaying any errors.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-4241[RHIDP-4241]


[id="bug-fix-rhidp-4732"]
=== The backstage instance always failed to start in version `5.1.0`

Before this update, the backstage instance failed to start in version `5.1.0`, showing an error.

With this update, the Role-Based Access Control (RBAC) Backend plugin now starts successfully in version `5.1.0` without displaying any errors.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-4732[RHIDP-4732]


[id="bug-fix-rhidp-4734"]
=== Resolved RBAC API inconsistency when scaling deployments to more than one pod

Before this update, scaling the deployment to more than one pod caused Role-Based Access Control (RBAC) roles to remain unsynced, allowing only the pod that created the resource to serve it.

With this update, RBAC roles are now properly synced across all pods, with Redis cache and traffic routing configured to ensure consistency across the deployment.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-4734[RHIDP-4734]


[id="bug-fix-rhidp-5014"]
=== `export-dynamic-plugin` fails to find dependencies nested deeper than one level in `node_modules`

Previously, the CLI examined the dependencies of embedded packages during the export process to know if other packages should be embedded. One of the methods was calling {{require}} when the CLI encountered a built embedded package, which was the case when wrapping an existing plugin.

This update changes the parent directory that the {{require}} uses from the monorepo root to the embedded package. Therefore, the dependent package found is the dependency that is most relevant to the embedded package.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-5014[RHIDP-5014]


[id="bug-fix-rhidp-5062"]
=== `suppress-native-package` and `allow-native-package` flags to handle native modules

Previously, the CLI failed with a message that native modules are not supported.

This update introduces two new CLI flags that help dynamic plugin developers handle native modules. Both flags accept a list of packages. The `--suppress-native-package` flag does not require the native module at runtime. It replaces the native module with an empty package that displays an error. The `--allow-native-package` flag instructs the CLI to allow the native package during checks, and tests a plugin that uses a native module.



.Additional resources
* link:https://issues.redhat.com/browse/RHIDP-5062[RHIDP-5062]


[id="bug-fix-rhidp-5120"]
=== Resolved the issue with text selection when reporting a TechDoc issue

Previously, the feature to report a documentation (TechDoc) issue failed. Therefore, when a user selected a text in a TechDoc, a large icon appeared instead of a tooltip button.

With this update, users can select texts when reporting a documentation (TechDoc) issue.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-5120[RHIDP-5120]


[id="bug-fix-rhidp-5136"]
=== Resolved the `stdout maxBuffer` error

Previously, the `export-dynamic-plugin` failed with an error that the `stdout maxBuffer` length was exceeded.

With this update, the CLI redirects the output of the {{yarn install}} command it performs during the export process to a file. Therefore, a successful completion of the {{yarn install}} command and verification of the `export-dynamic-plugin`, cleans up the file. The file is available for troubleshooting when the dynamic plugin validation checks fail.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-5136[RHIDP-5136]


[id="bug-fix-rhidp-5141"]
=== Added an `--ignore-version-check` flag

Previously, exporting a plugin that has not been updated to a newer backstage version failed due to a semver check performed on dependencies of the dynamic plugin package.

With this update, an `--ignore-version-check` flag accepts a list of package names causing the CLI to selectively ignore the semver check the CLI performs when evaluating the plugin package dependencies. Therefore, a plugin that has not been updated works because it relies on unchanged interfaces and functions.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-5141[RHIDP-5141]


[id="bug-fix-rhidp-5297"]
=== Updated the Tech Radar plugin

With this update, you are now required to enable both `./dynamic-plugins/dist/backstage-community-tech-radar` and `./dynamic-plugins/dist/backstage-community-tech-radar-backend-dynamic` to use the Tech Radar plugin. You must configure additional settings depending on where you choose to load the JSON data for the plugin.
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-5297[RHIDP-5297]



7 changes: 7 additions & 0 deletions modules/release-notes/ref-release-notes-known-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,12 @@

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

[id="known-issue-rhidp-3396"]
== Topology plugin permission is not displayed in the RBAC front-end UI

Permissions associated only with front-end plugins do not appear in the UI because they require a backend plugin to expose the permission framework's well-known endpoint. As a workaround, you can apply these permissions by using a CSV file or directly calling the REST API of the RBAC backend plugin. Affected plugins include Topology (`topology.view.read`), Tekton (`tekton.view.read`), ArgoCD (`argocd.view.read`), and Quay (`quay.view.read`).
.Additional resources
jmagak marked this conversation as resolved.
Show resolved Hide resolved
* link:https://issues.redhat.com/browse/RHIDP-3396[RHIDP-3396]



Loading
Loading