Skip to content

docs: document ref:// plugin reference syntax - #5204

Open
jonkoops wants to merge 1 commit into
redhat-developer:mainfrom
jonkoops:docs/ref-plugin-references
Open

docs: document ref:// plugin reference syntax#5204
jonkoops wants to merge 1 commit into
redhat-developer:mainfrom
jonkoops:docs/ref-plugin-references

Conversation

@jonkoops

@jonkoops jonkoops commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Documents the ref:// plugin reference syntax for the init container, matching the behaviour of the operator. Adds ref://plugin-name to the package field description, updates the default plugin activation example to show ref:// as the preferred approach, and adds a "Plugin References" section covering syntax, supported targets, and the relationship to {{inherit}}.

RHIDP-15876

Documents the ref:// plugin reference syntax for the init container,
matching the behaviour of the operator. Adds ref://plugin-name to the
package field description, updates the default plugin activation example
to show ref:// as the preferred approach, and adds a Plugin References
section covering syntax, supported targets, and the relationship to
{{inherit}}.

Ref: https://redhat.atlassian.net/browse/RHIDP-15876
Signed-off-by: Jon Koops <jonkoops@gmail.com>
@sonarqubecloud

sonarqubecloud Bot commented Aug 3, 2026

Copy link
Copy Markdown

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

The container image build workflow finished with status: failure.

@codecov

codecov Bot commented Aug 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 59.96%. Comparing base (84072ae) to head (f3a7217).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5204      +/-   ##
==========================================
- Coverage   63.69%   59.96%   -3.74%     
==========================================
  Files         123      111      -12     
  Lines        2424     2198     -226     
  Branches      572      527      -45     
==========================================
- Hits         1544     1318     -226     
  Misses        879      879              
  Partials        1        1              
Flag Coverage Δ
rhdh 59.96% <ø> (-3.74%) ⬇️
Components Coverage Δ
Backend plugins ∅ <ø> (∅)
Backend app 66.66% <ø> (ø)
Frontend app 58.89% <ø> (ø)
Plugin utils ∅ <ø> (∅)
Dynamic plugins utils ∅ <ø> (∅)

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 84072ae...f3a7217. 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

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

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


This resolves to the full package URL from the included configuration, so you do not need to know the registry, path, or version.

`ref://` supports OCI, HTTP(S), and local path targets. NPM package references are not supported as `ref://` targets.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Note, we support only oci: based catalog and it is not going to change AFAIK.
In general, I would remove this sentence.

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