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

[Feature request] Support monorepos in integration catalog #593

Open
benedfit opened this issue Sep 1, 2023 · 2 comments
Open

[Feature request] Support monorepos in integration catalog #593

benedfit opened this issue Sep 1, 2023 · 2 comments
Assignees
Labels
bug Something isn't working

Comments

@benedfit
Copy link

benedfit commented Sep 1, 2023

Describe the bug

Currently when adding items to the integration catalog, addons that are stored in monorepos do not current display the correct information

Steps to reproduce the behavior

  1. Go to https://storybook.js.org/addons/@newhighsco/storybook-addon-svgr/
  2. See that the README is not available
  3. Click on "View in Github"
  4. See that you land on https://github.com/newhighsco/storybook, the monorepo root, rather than the directory that contains the addon

Expected behavior

The package.json for @newhighsco/storybook-addon-svg contains details of the directory that contains the source and README -
https://github.com/newhighsco/storybook/blob/0d6c60da90e33ba609da122c429e3af4932ec320/packages/storybook-addon-svgr/package.json#L15-L19:

"repository": {
    "type": "git",
    "url": "https://github.com/newhighsco/storybook.git",
    "directory": "packages/storybook-addon-svgr"
 }

It would be great is the integration catalog could use the additional directory information, use it to find the README and append it to the "View in Github" href

@benedfit benedfit added the bug Something isn't working label Sep 1, 2023
@ShaunEvening
Copy link
Contributor

Hey @benedfit 👋

Thanks for the suggestion :) I'll definitely get around to this during my next round of maintenance on the scraper. In the mean time I can look at making sure that your README is at least shown on the details page. Apologies for that!

@kylegach
Copy link
Collaborator

kylegach commented Oct 10, 2023

Noting an offline discussion we had about this.

We use the homepage property (and sometimes the repository.url property) to grab the README. Yours is:

"homepage": "https://github.com/newhighsco/storybook/tree/main/packages/storybook-addon-svgr#readme"

And apparently, the #readme portion is what's breaking this.

We can probably just filter out /#.*$/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants