Skip to content

RHIDP-14055: modify dynamic plugins table process to fetch from index #2349

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.

Sign up for GitHub

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

Open
Omar-AlJaljuli wants to merge 5 commits into
base: main
Choose a base branch
from
Open

RHIDP-14055: modify dynamic plugins table process to fetch from index #2349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
866ce65
chore: modify dynamic plugins table process to fetch from index
Omar-AlJaljuli Jun 9, 2026
9e60c64
fix fetch-catalog-index
Omar-AlJaljuli Jun 9, 2026
922d321
chore: automated update of supported plugins list
Omar-AlJaljuli Jun 9, 2026
4589d47
Merge pull request #38 from Omar-AlJaljuli/update-main-20260609-142254
Omar-AlJaljuli Jun 9, 2026
925fbb6
Merge branch 'main' into main
themr0c Jun 10, 2026
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: 4 additions & 1 deletion .github/workflows/generate-supported-plugins-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,15 @@ jobs:
ref: ${{ matrix.target_branch }}
fetch-depth: 0

- name: Install PIP `yq`
- name: Install PIP `yq` and skopeo
if: steps.gate.outputs.run == 'true'
run: |
python3 -m pip install --upgrade pip
pip install yq
echo "Installed `yq` version: $(yq --version)"
sudo apt-get update
sudo apt-get install -y skopeo
echo "Installed skopeo version: $(skopeo --version)"

- name: Set up Git user
if: steps.gate.outputs.run == 'true'
Expand Down
27 changes: 27 additions & 0 deletions modules/extend_dynamic-plugins-reference/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
= Dynamic plugins reference module

The contents of this folder are updated by running the GH action in this repo against a specific branch

https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/actions/workflows/generate-supported-plugins-pr.yml

The action which will extract the generated content from the latest catalog index at https://quay.io/rhdh/plugin-catalog-index using the related branch (release-1.10 => `:1.10`, main => `:next`), then a pull request will be created that can be reviewed before merging.

Currently, the community plugins table at ref-community-supported-plugins.adoc is not generated from the same catalog index container. Instead it uses the contents of rhdh-plugin-export-overlays to get the list of plugins.

== Contributing to the dynamic plugins tables

Do not edit the fetched files directly in this repository, as they will be overwritten.

Instead, contribute changes to https://github.com/redhat-developer/rhdh-plugin-export-overlays[redhat-developer/rhdh-plugin-export-overlays], which will be either read directly (for community plugins) or downstreamed and built into a new image at https://quay.io/rhdh/plugin-catalog-index

== Automation

The GitHub Actions workflow `.github/workflows/generate-supported-plugins-pr.yml` runs `rhdh-supported-plugins.sh` weekly to open a pull request for updated content. It can also be run manually at any time.

== Requirements

Running the sync script locally requires:

* `skopeo`
* `jq`
* `yq` (the https://kislyuk.github.io/yq/[kislyuk/jq-wrapper] version, not mikefarah/yq)
5 changes: 3 additions & 2 deletions modules/extend_dynamic-plugins-reference/con-preinstalled-dynamic-plugins.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[role="_abstract"]
{product} is preinstalled with a selection of dynamic plugins.

The following 15 preinstalled dynamic plugins are enabled by default:
The following 16 preinstalled dynamic plugins are enabled by default:

* `@backstage-community/plugin-analytics-provider-segment`
* `@backstage-community/plugin-scaffolder-backend-module-regex`
Expand All @@ -22,8 +22,9 @@ The following 15 preinstalled dynamic plugins are enabled by default:
* `@red-hat-developer-hub/backstage-plugin-dynamic-home-page`
* `@red-hat-developer-hub/backstage-plugin-extensions-backend`
* `@red-hat-developer-hub/backstage-plugin-extensions`
* `@red-hat-developer-hub/backstage-plugin-global-floating-action-button`
* `@red-hat-developer-hub/backstage-plugin-global-header`
* `@red-hat-developer-hub/backstage-plugin-lightspeed-backend`
* `@red-hat-developer-hub/backstage-plugin-lightspeed`
* `@red-hat-developer-hub/backstage-plugin-quickstart`

The dynamic plugins that require custom configuration are disabled by default.
Expand Down
38 changes: 0 additions & 38 deletions ...extend_dynamic-plugins-reference/con-preinstalled-dynamic-plugins.template.adoc
View file
Open in desktop

This file was deleted.

7 changes: 6 additions & 1 deletion modules/extend_dynamic-plugins-reference/ref-community-supported-plugins.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
= {company-name} community supported plugins

[role="_abstract"]
{company-name} provides community support for the following 44 dynamic plugins in `ghcr.io`.
{company-name} provides community support for the following 45 dynamic plugins in `ghcr.io`.



Expand Down Expand Up @@ -43,6 +43,11 @@ Replace `<tag>` with the version tag corresponding to your {product-short} versi

`

|*Auth Frontend*
|0.1.6|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-auth:<tag>`

`

|*Azure DevOps Backend*
|0.27.0|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-azure-devops-backend:<tag>`

Expand Down
17 changes: 0 additions & 17 deletions modules/extend_dynamic-plugins-reference/ref-deprecated-plugins.template.adoc
View file
Open in desktop

This file was deleted.

82 changes: 35 additions & 47 deletions modules/extend_dynamic-plugins-reference/ref-ga-plugins.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
= {company-name} {generally-available} (GA) plugins

[role="_abstract"]
{company-name} provides full support for the following 33 dynamic plugins.
{company-name} provides full support for the following 31 dynamic plugins.

[%header,cols=4*]
|===
Expand All @@ -23,7 +23,7 @@
|`./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights-dynamic`


|Analytics Provider Segment |`https://npmjs.com/package/@backstage-community/plugin-analytics-provider-segment/v/1.27.0[@backstage-community/plugin-analytics-provider-segment]` |1.27.0
|Analytics Provider Segment |`https://npmjs.com/package/@backstage-community/plugin-analytics-provider-segment/v/1.27.0[@backstage-community/plugin-analytics-provider-segment]` |1.27.0
|`./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment`

`BACKSTAGE_VERSION`
Expand All @@ -35,57 +35,49 @@
`SEGMENT_WRITE_KEY`


|Dynamic Home Page |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-dynamic-home-page/v/1.13.1[@red-hat-developer-hub/backstage-plugin-dynamic-home-page]` |1.13.1
|Dynamic Home Page |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-dynamic-home-page/v/1.13.1[@red-hat-developer-hub/backstage-plugin-dynamic-home-page]` |1.13.1
|`./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-dynamic-home-page`


|GitHub Org |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-github-org/v/0.3.20[@backstage/plugin-catalog-backend-module-github-org]` |0.3.20
|GitHub Org |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-github-org/v/0.3.20[@backstage/plugin-catalog-backend-module-github-org]` |0.3.20
|`./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic`

`GITHUB_ORG`

`GITHUB_URL`


|GitHub |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-github/v/0.13.0[@backstage/plugin-catalog-backend-module-github]` |0.13.0
|GitHub |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-github/v/0.13.0[@backstage/plugin-catalog-backend-module-github]` |0.13.0
|`./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic`

`GITHUB_ORG`


|GitHub |`https://npmjs.com/package/@backstage/plugin-scaffolder-backend-module-github/v/0.9.7[@backstage/plugin-scaffolder-backend-module-github]` |0.9.7
|GitHub |`https://npmjs.com/package/@backstage/plugin-scaffolder-backend-module-github/v/0.9.7[@backstage/plugin-scaffolder-backend-module-github]` |0.9.7
|`./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-github-dynamic`


|GitLab Org |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-gitlab-org/v/0.2.19[@backstage/plugin-catalog-backend-module-gitlab-org]` |0.2.19
|GitLab Org |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-gitlab-org/v/0.2.19[@backstage/plugin-catalog-backend-module-gitlab-org]` |0.2.19
|`./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-gitlab-org-dynamic`

`GITLAB_HOST`

`GITLAB_ORG_GROUP`


|GitLab |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-gitlab/v/0.8.1[@backstage/plugin-catalog-backend-module-gitlab]` |0.8.1
|GitLab |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-gitlab/v/0.8.1[@backstage/plugin-catalog-backend-module-gitlab]` |0.8.1
|`./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-gitlab-dynamic`

`GITLAB_DISCOVERY_GROUP`

`GITLAB_HOST`


|Global Floating Action Button |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-global-floating-action-button/v/1.9.3[@red-hat-developer-hub/backstage-plugin-global-floating-action-button]` |1.9.3
|`./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-floating-action-button`


|Global Header |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-global-header/v/1.21.5[@red-hat-developer-hub/backstage-plugin-global-header]` |1.21.5
|`./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header`


|Http Request |`https://npmjs.com/package/@roadiehq/scaffolder-backend-module-http-request/v/5.6.0[@roadiehq/scaffolder-backend-module-http-request]` |5.6.0
|`oci://registry.access.redhat.com/rhdh/roadiehq-scaffolder-backend-module-http-request@sha256:2e498033306df2711ec2a548db0a9db921f911eb9b99af2b9e44162b4851bbe8`


|Keycloak |`https://npmjs.com/package/@backstage-community/plugin-catalog-backend-module-keycloak/v/3.19.2[@backstage-community/plugin-catalog-backend-module-keycloak]` |3.19.2
|Keycloak |`https://npmjs.com/package/@backstage-community/plugin-catalog-backend-module-keycloak/v/3.19.2[@backstage-community/plugin-catalog-backend-module-keycloak]` |3.19.2
|`./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic`

`KEYCLOAK_BASE_URL`
Expand All @@ -99,7 +91,7 @@
`KEYCLOAK_REALM`


|Kubernetes |`https://npmjs.com/package/@backstage/plugin-kubernetes-backend/v/0.21.2[@backstage/plugin-kubernetes-backend]` |0.21.2
|Kubernetes |`https://npmjs.com/package/@backstage/plugin-kubernetes-backend/v/0.21.2[@backstage/plugin-kubernetes-backend]` |0.21.2
|`./dynamic-plugins/dist/backstage-plugin-kubernetes-backend-dynamic`

`K8S_CLUSTER_NAME`
Expand All @@ -109,11 +101,11 @@
`K8S_CLUSTER_URL`


|Kubernetes |`https://npmjs.com/package/@backstage-community/plugin-scaffolder-backend-module-kubernetes/v/2.17.1[@backstage-community/plugin-scaffolder-backend-module-kubernetes]` |2.17.1
|Kubernetes |`https://npmjs.com/package/@backstage-community/plugin-scaffolder-backend-module-kubernetes/v/2.17.1[@backstage-community/plugin-scaffolder-backend-module-kubernetes]` |2.17.1
|`./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-kubernetes-dynamic`


|Ldap |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-ldap/v/0.12.3[@backstage/plugin-catalog-backend-module-ldap]` |0.12.3
|Ldap |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-ldap/v/0.12.3[@backstage/plugin-catalog-backend-module-ldap]` |0.12.3
|`./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-ldap-dynamic`

`LDAP_BIND_DN`
Expand All @@ -127,75 +119,71 @@
`LDAP_USERS_DN`


|MS Graph |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-msgraph/v/0.9.1[@backstage/plugin-catalog-backend-module-msgraph]` |0.9.1
|`./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-msgraph-dynamic`

`MICROSOFT_CLIENT_ID`

`MICROSOFT_CLIENT_SECRET`
|Lightspeed |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-lightspeed/v/2.9.0[@red-hat-developer-hub/backstage-plugin-lightspeed]` |2.9.0
|`oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-lightspeed@sha256:c68a58f268485e79e60a21e4f45e1c27b446bc17fcbb1af8a0e35b04d4f5cea7`

`MICROSOFT_TENANT_ID`

|Lightspeed |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-lightspeed-backend/v/2.9.0[@red-hat-developer-hub/backstage-plugin-lightspeed-backend]` |2.9.0
|`oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-lightspeed-backend@sha256:3147f09ad990fbcd22a9f613d6982b4534b235a2c2d27684fc1834e196cd83ff`

|Orchestrator Backend Module Loki |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator-backend-module-loki/v/1.2.6[@red-hat-developer-hub/backstage-plugin-orchestrator-backend-module-loki]` |1.2.6
|`oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-backend-module-loki@sha256:d5970c0e63d43162fa77f342a76b3bffbe54fe6cbabc56335ea11ecaa74591c4`

`AUTH_TOKEN`
|MS Graph |`https://npmjs.com/package/@backstage/plugin-catalog-backend-module-msgraph/v/0.9.1[@backstage/plugin-catalog-backend-module-msgraph]` |0.9.1
|`./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-msgraph-dynamic`

`LOKI_BASE_URL`
`MICROSOFT_CLIENT_ID`

`MICROSOFT_CLIENT_SECRET`

|Orchestrator Form Widgets |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator-form-widgets/v/1.10.7[@red-hat-developer-hub/backstage-plugin-orchestrator-form-widgets]` |1.10.7
|`oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-form-widgets@sha256:b8d9886e39fa1262bfe1046f6ec5825b8e576c4997c744e0f90f722453f35aec`
`MICROSOFT_TENANT_ID`


|Orchestrator |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator/v/5.7.12[@red-hat-developer-hub/backstage-plugin-orchestrator]` |5.7.12
|`oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator@sha256:062a536d266bcd76d454fc9fdc0157b99e62074f6d3304578a68f515ced83e64`
|Orchestrator Form Widgets |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator-form-widgets/v/1.10.8[@red-hat-developer-hub/backstage-plugin-orchestrator-form-widgets]` |1.10.8
|`oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-form-widgets@sha256:5671a9d01cb98b7172019ddb3b524b5c8089a081273db00c9da24057f9bb8db3`


|Orchestrator |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator-backend/v/8.9.4[@red-hat-developer-hub/backstage-plugin-orchestrator-backend]` |8.9.4
|`oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-backend@sha256:365d67fddeeaa2cf0b0266b012eb3e74fb5d5071b848059662353e62e7f9ceab`
|Orchestrator |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator/v/5.7.13[@red-hat-developer-hub/backstage-plugin-orchestrator]` |5.7.13
|`oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator@sha256:a26989fc49b4f2ce58e4764e928eacff000d4dd9007d06c553ce2ff6fe60c41f`


|Orchestrator |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-scaffolder-backend-module-orchestrator/v/1.5.4[@red-hat-developer-hub/backstage-plugin-scaffolder-backend-module-orchestrator]` |1.5.4
|`oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-scaffolder-backend-module-orchestrator@sha256:5b52adc153afcf79fb134262aa01b1e117085bf59c1a1997ff2e3a6f31c7647a`
|Orchestrator |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator-backend/v/8.9.5[@red-hat-developer-hub/backstage-plugin-orchestrator-backend]` |8.9.5
|`oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-backend@sha256:5e2e95950c3112a10c23c0fddae86b257d0cc16f9cde3dd2fc945b6a7be5f7c5`


|Quick start |`https://npmjs.com/package/@red-hat-developer-hub/backstage-plugin-quickstart/v/1.9.6[@red-hat-developer-hub/backstage-plugin-quickstart]` |1.9.6
|`./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-quickstart`


|RBAC |`https://npmjs.com/package/@backstage-community/plugin-rbac/v/1.52.4[@backstage-community/plugin-rbac]` |1.52.4
|RBAC |`https://npmjs.com/package/@backstage-community/plugin-rbac/v/1.52.4[@backstage-community/plugin-rbac]` |1.52.4
|`./dynamic-plugins/dist/backstage-community-plugin-rbac`


|Regex |`https://npmjs.com/package/@backstage-community/plugin-scaffolder-backend-module-regex/v/2.15.1[@backstage-community/plugin-scaffolder-backend-module-regex]` |2.15.1
|Regex |`https://npmjs.com/package/@backstage-community/plugin-scaffolder-backend-module-regex/v/2.15.1[@backstage-community/plugin-scaffolder-backend-module-regex]` |2.15.1
|`./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-regex-dynamic`


|Signals |`https://npmjs.com/package/@backstage/plugin-signals-backend/v/0.3.13[@backstage/plugin-signals-backend]` |0.3.13
|Signals |`https://npmjs.com/package/@backstage/plugin-signals-backend/v/0.3.13[@backstage/plugin-signals-backend]` |0.3.13
|`./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic`


|Tech Radar |`https://npmjs.com/package/@backstage-community/plugin-tech-radar/v/1.17.0[@backstage-community/plugin-tech-radar]` |1.17.0
|Tech Radar |`https://npmjs.com/package/@backstage-community/plugin-tech-radar/v/1.17.0[@backstage-community/plugin-tech-radar]` |1.17.0
|`./dynamic-plugins/dist/backstage-community-plugin-tech-radar`


|Tech Radar |`https://npmjs.com/package/@backstage-community/plugin-tech-radar-backend/v/1.16.0[@backstage-community/plugin-tech-radar-backend]` |1.16.0
|Tech Radar |`https://npmjs.com/package/@backstage-community/plugin-tech-radar-backend/v/1.16.0[@backstage-community/plugin-tech-radar-backend]` |1.16.0
|`./dynamic-plugins/dist/backstage-community-plugin-tech-radar-backend-dynamic`

`TECH_RADAR_DATA_URL`


|TechDocs Module Addons Contrib |`https://npmjs.com/package/@backstage/plugin-techdocs-module-addons-contrib/v/1.1.34[@backstage/plugin-techdocs-module-addons-contrib]` |1.1.34
|TechDocs Module Addons Contrib |`https://npmjs.com/package/@backstage/plugin-techdocs-module-addons-contrib/v/1.1.34[@backstage/plugin-techdocs-module-addons-contrib]` |1.1.34
|`./dynamic-plugins/dist/backstage-plugin-techdocs-module-addons-contrib`


|TechDocs |`https://npmjs.com/package/@backstage/plugin-techdocs/v/1.17.2[@backstage/plugin-techdocs]` |1.17.2
|TechDocs |`https://npmjs.com/package/@backstage/plugin-techdocs/v/1.17.2[@backstage/plugin-techdocs]` |1.17.2
|`./dynamic-plugins/dist/backstage-plugin-techdocs`


|TechDocs |`https://npmjs.com/package/@backstage/plugin-techdocs-backend/v/2.1.6[@backstage/plugin-techdocs-backend]` |2.1.6
|TechDocs |`https://npmjs.com/package/@backstage/plugin-techdocs-backend/v/2.1.6[@backstage/plugin-techdocs-backend]` |2.1.6
|`./dynamic-plugins/dist/backstage-plugin-techdocs-backend-dynamic`


Expand Down
15 changes: 0 additions & 15 deletions modules/extend_dynamic-plugins-reference/ref-ga-plugins.template.adoc
View file
Open in desktop

This file was deleted.

Loading
Loading