Skip to content

chore: pin techdocs-node to 1.14.4 so that it doesn't use the unavailable toError function#4962

Open
04kash wants to merge 1 commit into
redhat-developer:mainfrom
04kash:pin-techdocs-node
Open

chore: pin techdocs-node to 1.14.4 so that it doesn't use the unavailable toError function#4962
04kash wants to merge 1 commit into
redhat-developer:mainfrom
04kash:pin-techdocs-node

Conversation

@04kash

@04kash 04kash commented Jun 16, 2026

Copy link
Copy Markdown
Member

Description

RHDH 1.10 is on Backstage 1.49.4, so the RHDH backend provides @backstage/errors 1.2.7. We were pulling in @backstage/plugin-techdocs-node 1.14.5, which calls toError (added in errors 1.3.0). techdocs-node is bundled into the dynamic plugin, but @backstage/errors is a peerDep — it's not bundled, the RHDH backend provides it at runtime. So techdocs-node's ^1.3.0 declaration only affects the build workspace; it doesn't upgrade what the backend actually loads.

1.14.5 came in through global-header's caret on @backstage/plugin-search-backend-module-techdocs. Yarn resolved that to 0.4.13, which depends on techdocs-node ^1.14.5, and deduped it with the techdocs wrapper's 0.4.12 pin. techdocs-node 1.14.5 did bump its @backstage/errors minimum correctly (#33720); the problem is the RHDH backend still serves 1.2.7.

Fix

Pin @backstage/plugin-techdocs-node to 1.14.4 via resolutions in dynamic-plugins/package.json and the techdocs-backend wrapper, then regenerate dynamic-plugins/yarn.lock.

Alternative was bumping @backstage/errors to ^1.3.0 at the RHDH root.

Which issue(s) does this PR fix

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

Without pinning to 1.14.4, the following error is observed when mkdocs.yaml is not writable:
Screenshot From 2026-06-16 18-47-27

After pinning (with mkdocs.yaml still being non-writable), the correct warning message is shown:

Could not write to /home/kmittal/repos/rhdh-fork-latest/mkdocs.yaml after updating it before running the generator. EACCES: permission denied, open '/home/kmittal/repos/rhdh-fork-latest/mkdocs.yaml' {"span_id":"7096692277dbe62f","timestamp":"2026-06-16T23:08:47.115Z","trace_flags":"01","trace_id":"581a7bde305f983adfeeeb6f3dda91a4"}

@openshift-ci

openshift-ci Bot commented Jun 16, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@github-actions

Copy link
Copy Markdown
Contributor

The container image build workflow finished with status: cancelled.

@codecov

codecov Bot commented Jun 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 55.25%. Comparing base (33a1d92) to head (467f6ab).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4962      +/-   ##
==========================================
- Coverage   55.82%   55.25%   -0.58%     
==========================================
  Files         121      109      -12     
  Lines        2350     2132     -218     
  Branches      562      536      -26     
==========================================
- Hits         1312     1178     -134     
+ Misses       1032      953      -79     
+ Partials        6        1       -5     
Flag Coverage Δ
rhdh 55.25% <ø> (-0.58%) ⬇️

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 33a1d92...467f6ab. Read the comment docs.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@04kash 04kash force-pushed the pin-techdocs-node branch from 0b069e2 to ce8fafd Compare June 16, 2026 23:33
@github-actions

Copy link
Copy Markdown
Contributor

The container image build workflow finished with status: cancelled.

…able toError function

Signed-off-by: Kashish Mittal <kmittal@redhat.com>
@04kash 04kash force-pushed the pin-techdocs-node branch from ce8fafd to 467f6ab Compare June 16, 2026 23:34
@github-actions

Copy link
Copy Markdown
Contributor

The container image build workflow finished with status: cancelled.

@sonarqubecloud

Copy link
Copy Markdown

@04kash 04kash changed the title pin techdocs-node to 1.14.4 so that it doesn't use the unavailable toError function chore: pin techdocs-node to 1.14.4 so that it doesn't use the unavailable toError function Jun 16, 2026
@04kash 04kash marked this pull request as ready for review June 16, 2026 23:37
@openshift-ci openshift-ci Bot requested review from dom-aug and imykhno June 16, 2026 23:37
@04kash 04kash marked this pull request as draft June 16, 2026 23:43
@04kash 04kash marked this pull request as ready for review June 16, 2026 23:44
@openshift-ci openshift-ci Bot requested review from rohitkrai03 and rostalan June 16, 2026 23:44
@github-actions

Copy link
Copy Markdown
Contributor

Image was built and published successfully. It is available at:

@openshift-ci

openshift-ci Bot commented Jun 17, 2026

Copy link
Copy Markdown

@04kash: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-ocp-helm 467f6ab link true /test e2e-ocp-helm

Full PR test history. Your PR dashboard.

Details

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. I understand the commands that are listed here.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant