redhat-developer / redhat-developer/rhdh-plugin-export-utils

Publish workflow has completed with success should include a better hint how to test the plugin

Open
#22 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2
Forks
15
Avg merge
11h 5m
Merged PRs (30d)
2

Description

Currently the publish command creates a success message like this:

Publish workflow has completed with success.

  • Published container images:
    • ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-npm:pr_948__1.3.0

(from https://github.com/redhat-developer/rhdh-plugin-export-overlays/pull/948#issuecomment-2790199480)

I would be nice if it includes a dynamic plugin yaml example that includes also the used path, like;

Publish workflow has completed with success.

  • Published container images:
    • ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-npm:pr_948__1.3.0

You can test this container image in RHDH like this:

plugins: 
  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-npm:pr_948__1.3.0!backstage-community-plugin-npm-dynamic
    disabled: false
    pluginConfig:
      dynamicPlugins:
        frontend:
          backstage-community.plugin-npm: {}

or you could include some examples

plugins: 
  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-npm:pr_948__1.3.0!backstage-community-plugin-npm-dynamic
    disabled: false
    pluginConfig:
      dynamicPlugins:
        frontend:
          backstage-community.plugin-npm:
            # entityTabs:
            #   - mountPoint: entity.page.npm
            #     path: /TODO
            #     title: TODO
            #     config:
            #       if:
            #         allOf:
            #           - TODO
            # mountPoints:
            #   - mountPoint: entity.page.overview/cards
            #     importName: TODO
            #     config:
            #       layout:
            #         gridColumnEnd:
            #           xs: "span 12"
            #           md: "span 8"
            #       if:
            #         allOf:
            #           - TODO

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the publish workflow and the code that assembles its success message. Trace how the published image name and plugin metadata are available, then add a dynamic-plugin YAML example that includes the image path; done means the workflow comment provides a usable testing hint for the published plugin.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
build-system, release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.