Skip to content

chore: replace disabled with enabled in DP configs#453

Open
hopehadfield wants to merge 3 commits into
redhat-developer:mainfrom
hopehadfield:replace-disabled
Open

chore: replace disabled with enabled in DP configs#453
hopehadfield wants to merge 3 commits into
redhat-developer:mainfrom
hopehadfield:replace-disabled

Conversation

@hopehadfield

Copy link
Copy Markdown
Member

Description of the change

Replaces all instances of disabled field with enabled as a follow-up to redhat-developer/rhdh-plugins#3554

Which issue(s) does this PR fix or relate to

How to test changes / Special notes to the reviewer

Checklist

  • For each Chart updated, version bumped in the corresponding Chart.yaml according to Semantic Versioning.
  • For each Chart updated, variables are documented in the values.yaml and added to the corresponding README.md. The pre-commit utility can be used to generate the necessary content. Run pre-commit run --all-files to run the hooks and then push any resulting changes. The pre-commit Workflow will enforce this and warn you if needed.
  • JSON Schema template updated and re-generated the raw schema via the pre-commit hook.
  • Tests pass using the Chart Testing tool and the ct lint command.
  • If you updated the orchestrator-infra chart, make sure the versions of the Knative CRDs are aligned with the versions of the CRDs installed by the OpenShift Serverless operators declared in the values.yaml file. See Installing Knative Eventing and Knative Serving CRDs for more details.

Signed-off-by: Hope Hadfield <hhadfiel@redhat.com>
Signed-off-by: Hope Hadfield <hhadfiel@redhat.com>
@hopehadfield hopehadfield requested a review from a team as a code owner June 25, 2026 18:48
@openshift-ci openshift-ci Bot requested review from gazarenkov and rm3l June 25, 2026 18:48
@hopehadfield hopehadfield marked this pull request as draft June 25, 2026 18:48
@rhdh-qodo-merge

rhdh-qodo-merge Bot commented Jun 25, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📎 Requirement gaps (0) 📜 Skill insights (0)

Context used
✅ Tickets: RHIDP-14726

Grey Divider


Remediation recommended

1. README flag mismatch 🐞 Bug ⚙ Maintainability
Description
charts/backstage/README.md now documents plugin entries using an enabled flag, but a later example
block still uses disabled: false, creating contradictory instructions that can lead users to
configure the wrong key.
Code

charts/backstage/README.md[176]

+| global.dynamic.plugins | List of dynamic plugins, possibly overriding the plugins listed in `includes` files. Every item defines the plugin `package` as a [NPM package spec](https://docs.npmjs.com/cli/v10/using-npm/package-spec), an optional `pluginConfig` with plugin-specific backstage configuration, and an optional `enabled` flag to enable/disable a plugin listed in `includes` files. It also includes an `integrity` field that is used to verify the plugin package [integrity](https://w3c.github.io/webappsec-subresource-integrity/#integrity-metadata-description). | list | `[]` |
Relevance

⭐⭐⭐ High

Team frequently accepts README/doc fixes (typos/wording/values-table edits) in backstage chart docs
(e.g., PRs #173, #178, #351).

PR-#173
PR-#178
PR-#351

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The README’s values table now states an optional enabled flag for global.dynamic.plugins, but
later in the same README an example still shows disabled: false, demonstrating inconsistent
documentation.

charts/backstage/README.md[164-212]
charts/backstage/README.md[400-418]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`charts/backstage/README.md` partially migrated documentation to `enabled`, but it still contains an example using `disabled: false`. This leaves conflicting guidance for chart users.

### Issue Context
The values table entry for `global.dynamic.plugins` was updated to mention `enabled`, but the later "Enablement of Notifications Plugin" example block still shows `disabled`.

### Fix Focus Areas
- charts/backstage/README.md[176-176]
- charts/backstage/README.md[400-418]

### Suggested fix
- Update the remaining YAML example lines from `disabled: false` to the new `enabled` form (likely `enabled: true` in that example), and ensure any nearby prose aligns with the new key.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

@rhdh-qodo-merge

rhdh-qodo-merge Bot commented Jun 25, 2026

Copy link
Copy Markdown

PR Summary by Qodo

Helm: switch dynamic plugin flag from disabled to enabled
⚙️ Configuration changes 📝 Documentation 🕐 20-40 Minutes

Grey Divider

Description

• Rename dynamic plugin config field from disabled to enabled across Backstage chart values.
• Regenerate/update JSON schema and CI example values to match the new flag.
• Bump chart version and refresh README references for the updated configuration.
Diagram

graph TD
  U["Chart user"] --> H["Helm install/upgrade"] --> C["backstage chart"] --> V["values.yaml defaults"] --> T["Rendered manifests"]
  C --> S["values.schema.json"]
  C --> R["README.md"]
  C --> CI["ci/*-values.yaml"]
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Dual-field compatibility (support both `disabled` and `enabled` temporarily)
  • ➕ Reduces breaking-change risk for existing chart consumers
  • ➕ Allows a deprecation window with clear migration messaging
  • ➖ Adds complexity to templates/schema/docs
  • ➖ Creates ambiguity if both fields are set
2. Introduce a chart-level migration note with explicit versioned breaking change
  • ➕ Keeps implementation simple while making the upgrade impact explicit
  • ➕ Sets expectations for downstream automation/config repos
  • ➖ Still requires consumers to update values immediately
  • ➖ Does not help tooling that relies on old schema keys

Recommendation: The PR’s approach (rename everywhere + bump chart version + update schema/docs/examples) is the right baseline to keep the values contract consistent. If there is any meaningful installed base using disabled, consider adding a short deprecation/upgrade note (or temporary dual-field support) to minimize upgrade friction; otherwise, proceed as-is to align with the post-#3554 configuration model.

Files changed (6) +21 / -21

Documentation (1) +5 / -5
README.mdRefresh README for 6.1.2 and 'enabled' plugin flag wording +5/-5

Refresh README for 6.1.2 and 'enabled' plugin flag wording

• Updates the displayed chart version and install example to 6.1.2. Adjusts documented plugin list semantics to refer to an 'enabled' flag instead of 'disabled', and updates embedded example JSON snippets accordingly.

charts/backstage/README.md

Other (5) +16 / -16
Chart.yamlBump chart patch version to 6.1.2 +1/-1

Bump chart patch version to 6.1.2

• Updates the Backstage chart version from 6.1.1 to 6.1.2 to publish the config contract change.

charts/backstage/Chart.yaml

with-orchestrator-and-dynamic-plugins-npmrc-values.yamlUpdate CI values to use 'enabled: true' for dynamic plugins +2/-2

Update CI values to use 'enabled: true' for dynamic plugins

• Replaces 'disabled: false' with 'enabled: true' for additional dynamic plugin entries in the orchestrator+dynamic-plugins CI scenario.

charts/backstage/ci/with-orchestrator-and-dynamic-plugins-npmrc-values.yaml

with-orchestrator-values.yamlUpdate CI values to use 'enabled: true' for dynamic plugins +2/-2

Update CI values to use 'enabled: true' for dynamic plugins

• Replaces 'disabled: false' with 'enabled: true' for additional dynamic plugin entries in the orchestrator CI scenario.

charts/backstage/ci/with-orchestrator-values.yaml

values.schema.jsonRegenerate schema defaults to use 'enabled' field +4/-4

Regenerate schema defaults to use 'enabled' field

• Updates schema-provided default plugin entries under Lightspeed to use 'enabled: true' rather than 'disabled: false', keeping the schema aligned with the chart’s values contract.

charts/backstage/values.schema.json

values.yamlRename plugin toggle field from 'disabled' to 'enabled' in defaults +7/-7

Rename plugin toggle field from 'disabled' to 'enabled' in defaults

• Updates comments and default plugin lists (Lightspeed and orchestrator) to use 'enabled: true' instead of 'disabled: false', matching the new expected configuration key.

charts/backstage/values.yaml

@rhdh-qodo-merge rhdh-qodo-merge Bot added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 25, 2026
Signed-off-by: Hope Hadfield <hhadfiel@redhat.com>
@sonarqubecloud

Copy link
Copy Markdown

@hopehadfield hopehadfield marked this pull request as ready for review June 25, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant