Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Basic attempt to implement the README card functionality #84

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lackerman
Copy link

As per the discussion on #25
this is the work I did to enable this functionality with a custom
plugin, now within the context of the Gitlab plugin.

@satrox28
Copy link
Collaborator

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

As per the discussion on loblaw-sre#25
this is the work I did to enable this functionality with a custom
plugin.

Signed-off-by: Leo Ackerman <[email protected]>
@FlxPeters
Copy link

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

@satrox28
Copy link
Collaborator

satrox28 commented Sep 22, 2022

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.

@FlxPeters
Copy link

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.

@s-diez
Copy link

s-diez commented Oct 5, 2022

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.

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.

4 participants