Skip to content

chore(install): merge plugin config for include files #3143

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

Conversation

dzemanov
Copy link
Member

@dzemanov dzemanov commented Jul 17, 2025

Description

Plugins defined in include files are overwriting plugin configuration as a whole. This changes the behaviour to instead merge, only overwriting the specific keys they define while retaining the keys defined in previous include files, as is being done for plugins under plugins key.

This is needed for Extensions plugin to be able to use pluginConfig from default plugins file when enabling preinstalled plugins.

Which issue(s) does this PR fix

Demo

marketplace-include-config.mov

How to test on rhdh-local

Create dynamic-plugins.marketplace.yaml under configs/app-config with this content

plugins:
  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import
    disabled: false
  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import-backend-dynamic
    disabled: false

add to dynamic-plugins.override.yaml:

# Example dynamic plugin override config.
# Copy to dynamic-plugins.override.yaml to activate local plugins.

includes:
  - dynamic-plugins.default.yaml
  - /opt/app-root/src/configs/app-config/dynamic-plugins.marketplace.yaml

# Below you can add custom dynamic plugins, including local ones.
plugins: []

Bulk import should be successfully mounted although it doesnt have pluginConfig specified in dynamic-plugins.marketplace.yaml

PR acceptance criteria

Please make sure that the following steps are complete:

  • GitHub Actions are completed and successful
  • Unit Tests are updated and passing
  • E2E Tests are updated and passing
  • Documentation is updated if necessary (requirement for new features)
  • Add a screenshot if the change is UX/UI related

How to test changes / Special notes to the reviewer

Signed-off-by: Dominika Zemanovicova <[email protected]>
@dzemanov dzemanov force-pushed the merge-plugin-config-of-includes branch from 4870b1c to ab8c78d Compare July 17, 2025 08:25
Copy link
Contributor

@dzemanov
Copy link
Member Author

/cc @kadel

@kadel
Copy link
Member

kadel commented Jul 17, 2025

/approve
/lgtm

Copy link

openshift-ci bot commented Jul 17, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kadel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-bot openshift-merge-bot bot merged commit 2448acc into redhat-developer:main Jul 17, 2025
17 of 18 checks passed
@PatAKnight
Copy link
Member

/cherry-pick release-1.7

@openshift-cherrypick-robot
Copy link
Contributor

@PatAKnight: new pull request created: #3148

In response to this:

/cherry-pick release-1.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants