Skip to content

chore(backstage): Switch default tag to next on the main branch#276

Merged
rm3l merged 2 commits intoredhat-developer:mainfrom
rm3l:chore/switch_backstage_image_tag_to_next_on_main_to_be_consistent_with_operator
Dec 5, 2025
Merged

chore(backstage): Switch default tag to next on the main branch#276
rm3l merged 2 commits intoredhat-developer:mainfrom
rm3l:chore/switch_backstage_image_tag_to_next_on_main_to_be_consistent_with_operator

Conversation

@rm3l
Copy link
Copy Markdown
Member

@rm3l rm3l commented Dec 5, 2025 •
edited
Loading

Description of the change

This is to be consistent with what we have in the operator repo, where we use next on the main branch by default: https://github.com/redhat-developer/rhdh-operator/blob/main/config/profile/rhdh/patches/deployment-patch.yaml#L30

We continue to pin the tag to 1.y in the respective release-1.y branches: https://github.com/redhat-developer/rhdh-chart/blob/release-1.8/charts/backstage/values.yaml#L41

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. Use pre-commit run -a to apply changes. The pre-commit Workflow will do this automatically for 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.

@rm3l
chore(backstage): Switch default tag to next on main
390eaf5 
This is to be consistent with what we have in the operator repo, where we use next on the main branch by default
@rhdh-qodo-merge
Copy link
Copy Markdown

rhdh-qodo-merge Bot commented Dec 5, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🔒 No security concerns identified
⚡ Recommended focus areas for review

Docs Drift

Ensure all README references (badges, install commands, examples) consistently reflect the new chart version 4.7.0, including any additional occurrences not shown in this diff.

 
# RHDH Backstage Helm Chart for OpenShift

![Version: 4.7.0](https://img.shields.io/badge/Version-4.7.0-informational?style=flat-square)
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A Helm chart for deploying Red Hat Developer Hub, which is a Red Hat supported version of Backstage.

The telemetry data collection feature is enabled by default. Red Hat Developer Hub sends telemetry data to Red Hat by using the `backstage-plugin-analytics-provider-segment` plugin. To disable this and to learn what data is being collected, see https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html-single/telemetry_data_collection_and_analysis/index

**Homepage:** <https://red.ht/rhdh>

## Productized RHDH

This repository now provides the productized RHDH chart.
For the **Generally Available** version of this chart, see:

* https://github.com/openshift-helm-charts/charts - official releases to https://charts.openshift.io/

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Red Hat |  | <https://redhat.com> |

## TL;DR

```console
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add backstage https://backstage.github.io/charts
helm repo add redhat-developer https://redhat-developer.github.io/rhdh-chart

helm install my-backstage redhat-developer/backstage --version 4.7.0

Introduction


</details>

</td></tr>
<tr><td>📚&nbsp;<strong>Focus areas based on broader codebase context</strong><br><br>

<details><summary><a href='https://github.com/redhat-developer/rhdh-chart/pull/276/files#diff-8060d9a38501197eddb026fced7fe56f104f4f5143210c6d47781b831a7097f4R39-R42'><strong>Consistency Check</strong></a>

Verify that switching the default Backstage image tag to `next` aligns with deployment expectations across environments. Ensure related docs and examples in this chart consistently use `next` and that CI or promotion workflows don't rely on `latest`. (<a href="https://github.com/redhat-developer/rhdh-operator/blob/029f3e1/config/profile/rhdh/default-config/deployment.yaml/#L83-L99">Ref 2</a>, <a href="https://github.com/redhat-developer/rhdh-operator/blob/d5d22c9/examples/rhdh-cr.yaml/#L70-L94">Ref 3</a>)
</summary>

```yaml
registry: quay.io
repository: rhdh/rhdh-hub-rhel9
tag: next
pullPolicy: IfNotPresent

Reference reasoning: The operator repo defaults Backstage images to quay.io/rhdh-community/rhdh:next in both default configs and CR examples, indicating next is the intended default. Aligning this chart to next is consistent, but requires checking ancillary references and automation that previously assumed latest.

📄 References
  1. redhat-developer/rhdh-operator/config/profile/rhdh/patches/deployment-patch.yaml [1-32]
  2. redhat-developer/rhdh-operator/config/profile/rhdh/default-config/deployment.yaml [83-99]
  3. redhat-developer/rhdh-operator/examples/rhdh-cr.yaml [70-94]
  4. redhat-developer/rhdh-chart/charts/orchestrator-software-templates-infra/values.yaml [1-18]
  5. redhat-developer/rhdh-chart/charts/orchestrator-software-templates-infra/ci/upstream-values.yaml [1-27]
  6. redhat-developer/rhdh-chart/charts/orchestrator-software-templates/values.yaml [46-50]
  7. redhat-developer/rhdh-operator/dist/backstage.io/install.yaml [2012-2047]
  8. redhat-developer/rhdh-operator/bundle/backstage.io/manifests/backstage-operator.clusterserviceversion.yaml [198-204]

@rhdh-qodo-merge rhdh-qodo-merge Bot added the enhancement New feature or request label Dec 5, 2025
@rhdh-qodo-merge
Copy link
Copy Markdown

rhdh-qodo-merge Bot commented Dec 5, 2025 •
edited
Loading

PR Type

(Describe updated until commit 4eed430)

Enhancement

Description

  • Switch Backstage image tag default from latest to next on main branch

  • Align with operator repository configuration for consistency

  • Bump chart version from 4.6.3 to 4.7.0 following semantic versioning

  • Update schema and documentation to reflect new default tag

File Walkthrough
Relevant files
Configuration changes
Chart.yaml
Bump chart version to 4.7.0                                                           

charts/backstage/Chart.yaml

  • Bumped chart version from 4.6.3 to 4.7.0 to reflect the default tag
    change
 +1/-1     
values.schema.json
Update schema default image tag to next                                   

charts/backstage/values.schema.json

  • Changed default Backstage image tag from latest to next in JSON schema
 +1/-1     
values.yaml
Update values default image tag to next                                   

charts/backstage/values.yaml

  • Changed default Backstage image tag from latest to next in values
    configuration
 +1/-1     
Documentation
README.md
Update documentation version references                                   

charts/backstage/README.md

  • Updated version badge from 4.6.3 to 4.7.0
  • Updated helm install command example to reference new chart version
 +2/-2     

@rhdh-qodo-merge
Copy link
Copy Markdown

rhdh-qodo-merge Bot commented Dec 5, 2025 •
edited
Loading

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Update tag description to warn users

Update the image tag's description to warn users that the default next tag is a
mutable development build and not recommended for production, aligning the
description with the new default value.

charts/backstage/values.schema.json [4597-4602]

 "tag": {
     "default": "next",
-    "description": "Immutable tags are recommended.",
+    "description": "The default tag points to a development build and is not guaranteed to be stable. Immutable tags are recommended for production use.",
     "title": "Backstage image tag",
     "type": "string"
 }
  • Apply / Chat
Suggestion importance[1-10]: 6

__

Why: The suggestion correctly identifies a contradiction between the new default tag next and the description which recommends immutable tags, proposing a documentation improvement to warn users about potential instability.

Low
  • Update

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Dec 5, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@rm3l rm3l marked this pull request as ready for review December 5, 2025 13:12
@rm3l rm3l merged commit 1890e4f into redhat-developer:main Dec 5, 2025
6 of 7 checks passed
@rm3l rm3l deleted the chore/switch_backstage_image_tag_to_next_on_main_to_be_consistent_with_operator branch December 5, 2025 13:12
@rhdh-qodo-merge
Copy link
Copy Markdown

rhdh-qodo-merge Bot commented Dec 5, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🔒 No security concerns identified
⚡ Recommended focus areas for review

Behavior Change

Switching the default Backstage image tag from latest to next changes the upgrade channel on main; verify CI, tests, and docs assume next and that users understand the potential instability of next images compared to pinned releases.

 
tag: next
pullPolicy: IfNotPresent
Schema Consistency

The schema default for tag is now next. Ensure any validation, examples, and README narrative reflect this change and that templates don’t still rely on latest elsewhere.

 
    "default": "next",
    "description": "Immutable tags are recommended.",
    "title": "Backstage image tag",
    "type": "string"
}
📚 Focus areas based on broader codebase context

Tag Consistency

Verify the image repository path aligns with the chosen next tag. Operator examples use quay.io/rhdh-community/rhdh:next, while this chart sets quay.io/rhdh/rhdh-hub-rhel9:next. Confirm cross-repo consistency or document the intended difference to avoid mismatched images between operator and chart. (Ref 1, Ref 2)

 
registry: quay.io
repository: rhdh/rhdh-hub-rhel9
tag: next
pullPolicy: IfNotPresent

Reference reasoning: The operator’s default and example deployments reference the rhdh-community/rhdh:next image, indicating next is published under that repository. The chart points to rhdh/rhdh-hub-rhel9 with tag next, which may refer to a different image path; aligning or clarifying ensures users deploying via operator and chart pull compatible images.

📄 References
  1. redhat-developer/rhdh-operator/config/profile/rhdh/default-config/deployment.yaml [83-99]
  2. redhat-developer/rhdh-operator/examples/rhdh-cr.yaml [70-94]
  3. redhat-developer/rhdh-chart/charts/backstage/ci/with-orchestrator-values.yaml [1-21]
  4. redhat-developer/rhdh-chart/charts/orchestrator-software-templates-infra/values.yaml [1-18]
  5. redhat-developer/rhdh-chart/charts/orchestrator-software-templates-infra/ci/upstream-values.yaml [1-27]
  6. redhat-developer/rhdh-operator/config/profile/rhdh/default-config/deployment.yaml [1-20]
  7. redhat-developer/rhdh-operator/config/profile/backstage.io/default-config/deployment.yaml [1-36]
  8. redhat-developer/rhdh-operator/bundle/backstage.io/manifests/backstage-default-config_v1_configmap.yaml [163-198]

@rhdh-qodo-merge
Copy link
Copy Markdown

rhdh-qodo-merge Bot commented Dec 5, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Clarify that the default tag is mutable

Update the description for the image tag to clarify that the default next tag is
for development and not recommended for production, advising the use of
immutable tags for stable deployments.

charts/backstage/values.schema.json [4597-4602]

 "tag": {
     "default": "next",
-    "description": "Immutable tags are recommended.",
+    "description": "The default 'next' tag is for development purposes and not recommended for production. For stable deployments, please use an immutable, versioned tag.",
     "title": "Backstage image tag",
     "type": "string"
 }
  • Apply / Chat
Suggestion importance[1-10]: 6

__

Why: The suggestion correctly identifies a contradiction between the new default tag next and the existing description that recommends immutable tags, improving user guidance and preventing potential misuse in production.

Low
  • More

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

Reviewers

@subhashkhileri subhashkhileri Awaiting requested review from subhashkhileri

@zdrapela zdrapela Awaiting requested review from zdrapela

Assignees

No one assigned

Labels

enhancement New feature or request Review effort 2/5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@rm3l