Skip to content

feat(quickstart): dynamic version of rhdh in documentation links #4017

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
its-mitesh-kumar wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −4
Open

feat(quickstart): dynamic version of rhdh in documentation links #4017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions docker/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ RUN \
-e "s/(\"Last Commit\": \"(.+)\")/\1, \"Build Time\": \"$now\"/" && \
cat packages/app/src/build-metadata.json; echo

# Replace ${RHDH_DOCS_VERSION:-latest} placeholder with actual version (major.minor) from package.json
Copy link
Member

@nickboldt nickboldt Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if doing this in docker/Dockerfile should do the same in .rhdh/docker/Dockerfile too... but there we have metadata which defines the version of RHDH. Why do you need a different version here for the DOCS of the RHDH version? Surely they're the same since the docs use the same value in https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/blob/main/artifacts/attributes.adoc#L16 ?

RUN RHDH_DOCS_VERSION=$(node -p "require('./package.json').version.split('.').slice(0,2).join('.')") && \
sed -i "s/\${RHDH_DOCS_VERSION:-latest}/$RHDH_DOCS_VERSION/g" dynamic-plugins.default.yaml

# suppress git warnings about dubious ownership in repository at '/opt/app-root/src' when building
RUN echo "=== YARN BUILD ==="; FAILED=0; \
git config --global --add safe.directory /opt/app-root/src; \
Expand Down
4 changes: 2 additions & 2 deletions dynamic-plugins.default.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ plugins:
cta:
text: Learn more
textKey: steps.setupAuthentication.ctaTitle
link: https://docs.redhat.com/en/documentation/red_hat_developer_hub/latest/html/authentication_in_red_hat_developer_hub/
link: https://docs.redhat.com/en/documentation/red_hat_developer_hub/${RHDH_DOCS_VERSION}/html/authentication_in_red_hat_developer_hub/
- title: Configure RBAC
titleKey: steps.configureRbac.title
icon: Rbac
Expand All @@ -524,7 +524,7 @@ plugins:
cta:
text: Learn more
textKey: steps.configureGit.ctaTitle
link: https://docs.redhat.com/en/documentation/red_hat_developer_hub/latest/html/integrating_red_hat_developer_hub_with_github/
link: https://docs.redhat.com/en/documentation/red_hat_developer_hub/${RHDH_DOCS_VERSION}/html/integrating_red_hat_developer_hub_with_github/
- title: Manage plugins
titleKey: steps.managePlugins.title
icon: Plugins
Copy link
Member

@nickboldt nickboldt Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The DPDY file (dynamic-plugins.default.yaml) file is generated downstream in the https://gitlab.cee.redhat.com/rhidp/rhdh-plugin-catalog/-/blob/rhdh-1-rhel-9/build/scripts/generateDynamicPluginsDefaultYaml.py

If you would like to embed a version, we can do it there.

Expand Down
6 changes: 4 additions & 2 deletions e2e-tests/playwright/e2e/plugins/quick-start.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,19 @@ test.describe("Test Quick Start plugin", () => {
await uiHelper.verifyText("We'll guide you through a few quick steps");
await uiHelper.verifyText("Not started");
await uiHelper.clickButtonByText("Set up authentication");
// URL version is replaced at build time from package.json (e.g., "1.9")
await uiHelper.verifyButtonURL(
"Learn more",
"https://docs.redhat.com/en/documentation/red_hat_developer_hub/latest/html/authentication_in_red_hat_developer_hub/",
"docs.redhat.com/en/documentation/red_hat_developer_hub/",
{ exact: false },
);
await uiHelper.clickButtonByText("Configure RBAC");
await uiHelper.verifyButtonURL("Manage access", "/rbac");
await uiHelper.clickButtonByText("Configure Git");
// URL version is replaced at build time from package.json (e.g., "1.9")
await uiHelper.verifyButtonURL(
"Learn more",
"https://docs.redhat.com/en/documentation/red_hat_developer_hub/latest/html/integrating_red_hat_developer_hub_with_github/",
"docs.redhat.com/en/documentation/red_hat_developer_hub/",
Copy link
Member

@nickboldt nickboldt Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why remove the https:// and the suffix to the actual page?

{ exact: false },
);
await uiHelper.clickButtonByText("Manage plugins");
Expand Down
Loading