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

Update package.json metadata to link to package directory inside monorepo #1311

Open
trivikr opened this issue Feb 19, 2024 · 1 comment
Open

Comments

@trivikr
Copy link
Contributor

trivikr commented Feb 19, 2024

Affected Packages

All

Problem

The repository and homepage links on npmjs website link to the GitHub repo, and not the directory inside monorepo.

For example, view @changesets/cli:

Proposed solution

Change package.json metadata such that home page links to source code on GitHub and repository links to root folder of monorepo

For example, the medata for @changesets/cli should be:

@trivikr
Copy link
Contributor Author

trivikr commented Feb 19, 2024

For @changesets/cli, this can be done by updating the following in package.json

{
  "homepage": "https://github.com/changesets/changesets/tree/main/packages/cli",
  "repository": {
    "type": "git",
    "url": "https://github.com/changesets/changesets.git",
    "directory": "packages/cli"
  }
}

This is similar to how it's done for @aws-sdk/client-s3
Source code: https://github.com/aws/aws-sdk-js-v3/blob/f77c77f0ce6e371c1a8fe53add0b0ab4c33b98ab/clients/client-s3/package.json#L121-L126

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

No branches or pull requests

1 participant