Skip to content

docs: add backstage-cli usage guide for RHDH#4901

Open
kadel wants to merge 2 commits into
redhat-developer:mainfrom
kadel:backstage-cli-docs
Open

docs: add backstage-cli usage guide for RHDH#4901
kadel wants to merge 2 commits into
redhat-developer:mainfrom
kadel:backstage-cli-docs

Conversation

@kadel

@kadel kadel commented May 29, 2026

Copy link
Copy Markdown
Member

Document how to use @backstage/cli auth and actions commands with RHDH, including auth plugin setup, OAuth2 endpoint configuration, standalone usage workaround for npm peer dependency conflicts, and troubleshooting.

Assisted-by: Claude Code

Description

Please explain the changes you made here.

Which issue(s) does this PR fix

related to https://redhat.atlassian.net/browse/RHIDP-14120

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

@openshift-ci openshift-ci Bot requested review from gashcrumb and hmanwani-rh May 29, 2026 09:37
@codecov

codecov Bot commented May 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.86%. Comparing base (105732d) to head (b8506ea).
⚠️ Report is 54 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4901      +/-   ##
==========================================
- Coverage   53.65%   52.86%   -0.80%     
==========================================
  Files         121      109      -12     
  Lines        2350     2132     -218     
  Branches      539      537       -2     
==========================================
- Hits         1261     1127     -134     
+ Misses       1084     1004      -80     
+ Partials        5        1       -4     
Flag Coverage Δ
rhdh 52.86% <ø> (-0.80%) ⬇️

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 105732d...b8506ea. 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.

@github-actions

Copy link
Copy Markdown
Contributor

The container image build workflow finished with status: cancelled.

kadel added 2 commits May 29, 2026 11:55
Document how to use @backstage/cli auth and actions commands with RHDH,
including auth plugin setup, OAuth2 endpoint configuration, standalone
usage workaround for npm peer dependency conflicts, and troubleshooting.

Assisted-by: Claude Code
@kadel kadel force-pushed the backstage-cli-docs branch from e750114 to b8506ea Compare May 29, 2026 09:56
@github-actions

Copy link
Copy Markdown
Contributor

The container image build workflow finished with status: cancelled.

@sonarqubecloud

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown
Contributor

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

@kadel kadel requested review from durandom and yangcao77 June 1, 2026 08:59
@github-actions

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 7 days with no activity. Remove stale label or comment or this will be closed in 21 days.

@github-actions github-actions Bot added Stale and removed Stale labels Jun 17, 2026
@github-actions

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 7 days with no activity. Remove stale label or comment or this will be closed in 21 days.

@github-actions github-actions Bot added the Stale label Jun 26, 2026
@gabemontero

gabemontero commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

@yangcao77 - what @kadel has here looks analogous to what I saw from your google doc https://docs.google.com/document/d/1X_kIDDhyTdndrK81bfJL9bvLm0z5ShJc42tHXg4RQ84/edit?tab=t.0 and
https://docs.google.com/document/d/1ZAfV6oTNnhcKg_xA5z0u6-t_5NMj_NYlvm5zZQgEWBk/edit?tab=t.0#heading=h.lwajsvbry7av and
https://docs.google.com/document/d/1wgH8yENCTzxml7rgbvKgixhw75VrsFJUzIFdNmKsQVg/edit?tab=t.0#heading=h.44w104d3ha07

I think you two have been corresponding on CLI work, but admittedly am not 100% certain of that

First blush, I would think we would want the state of the CLI (including perhaps those findings of things that need enhancement you've got) stored somewhere like this in github, no ? Perhaps some link to docs like this in the rhdh-plugins repo too ...

I did try to search through RHIDP-14120 (IIUC that lead to the producing of @yangcao77 's google docs) but saw no discussion around even considering storing this useful information in github somewhere (vs. just google docs) ...

apologies @kadel @yangcao77 if what I am asking about has been sorted out somewhere and I'm just missing it

thanks

@github-actions github-actions Bot removed the Stale label Jun 27, 2026
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.

2 participants