backstage-plugin-gitlab icon indicating copy to clipboard operation
backstage-plugin-gitlab copied to clipboard

Published 20 hours ago • verified publisher icon loblaw-sre

Basic attempt to implement the README card functionality

Open lackerman opened this issue 2 years ago • 5 comments

As per the discussion on https://github.com/loblaw-sre/backstage-plugin-gitlab/issues/25 this is the work I did to enable this functionality with a custom plugin, now within the context of the Gitlab plugin.

lackerman avatar Feb 17 '22 14:02 lackerman

Hi @lackerman thanks, will take a look. Can you sign your commit to pass DCO.

satrox28 avatar Feb 17 '22 14:02 satrox28

Is there anything to do or help in order to get this PR merged?

FlxPeters avatar Sep 22 '22 12:09 FlxPeters

Hi @FlxPeters can you please take a look and see if the readme card renders the markdown correctly, last time when we checked it had issues in rendering the images from markdown.

satrox28 avatar Sep 22 '22 19:09 satrox28

I will check it and may be add a new PR. My use case is to have an brief overview and long description for components. So images do not really matter for me, but i understand it's not nice when they are broken.

FlxPeters avatar Sep 24 '22 07:09 FlxPeters

Hi I just tried the plugin and noticed some issues.

  • Shouldn't the EntityGitlabReadmeCard be exported in the index.ts
  • The default branch currently set to master should be configurable through an annotation. Main is quite common now.
  • Should the card be displayed on the gitlab tab (EntityGitlabContent)

About the images I tested the following. I think the result is as expected.

  • Images with full URLs work
  • References to local files (relative URL) do not work.

s-diez avatar Oct 05 '22 07:10 s-diez