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

Fix repository metadata for some packages #1776

Closed
aaronadamsCA opened this issue May 26, 2021 · 3 comments · Fixed by #1779
Closed

Fix repository metadata for some packages #1776

aaronadamsCA opened this issue May 26, 2021 · 3 comments · Fixed by #1779
Labels
released This issue/pull request has been released.

Comments

@aaronadamsCA
Copy link
Contributor

Describe the bug
Some packages, like @theme-ui/color, don't include repository metadata on NPM.

To Reproduce
Compare these two NPM packages:

Only the first package lists its repository as https://github.com/system-ui/theme-ui.

Expected behavior
All monorepo packages list their repository as https://github.com/system-ui/theme-ui.

Easiest fix is to ensure this fragment appears in every packages/*/package.json:

{
  "repository": "system-ui/theme-ui"
}

Additional context
This makes it more difficult to configure tools like Renovate, which use the repository metadata to identify packages that live in the Theme UI monorepo and upgrade them in lockstep.

There is support in the package.json spec for specifying the directory for each package, like so:

{
  "repository": {
    "type": "git",
    "url": "https://github.com/system-ui/theme-ui",
    "directory": "packages/core"
  }
}

But I don't see any tooling that uses this much more verbose format, so I'm not sure the complexity adds anything.

Let me know the preferred format and I'm happy to submit a PR, looks like an easy low-risk update.

@hasparus
Copy link
Member

Hey @aaronadamsCA! Thanks for the issue! I didn't know the concise format before :) Go with the one you prefer.

@hasparus hasparus added the prerelease This change is available in a prerelease. label May 27, 2021
@aaronadamsCA
Copy link
Contributor Author

aaronadamsCA commented May 27, 2021

I didn't know the concise format before :)

Neither did I, I learned it from this repo!

Thanks for merging; I also filed renovatebot/renovate#10281, so Renovate now has built-in support for Theme UI, which will work correctly as soon as v0.9.2 is released.

@hasparus
Copy link
Member

🚀 Issue was released in v0.10.0 🚀

@hasparus hasparus added released This issue/pull request has been released. and removed prerelease This change is available in a prerelease. labels Jun 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants