conventional-changelog icon indicating copy to clipboard operation
conventional-changelog copied to clipboard

Add `directory` metadata to each `packages/*/package.json` file

Open HonkingGoose opened this issue 2 years ago • 0 comments

Problem description

The packages/*/package.json files lack the "directory" property in their "repository" object.

Example of a package.json file that's missing this property:

https://github.com/conventional-changelog/conventional-changelog/blob/21b73f974adc4490a318d9c892055655cb82c538/packages/conventional-changelog-angular/package.json#L9-L12

I think this is the reason that bots cannot fetch the release notes when they're creating an update PR for packages coming from this project's monorepo.

npm documentation for directory property

Relevant quote from the npm documentation ^docs:

If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives:

{
  "repository": {
    "type": "git",
    "url": "https://github.com/facebook/react.git",
    "directory": "packages/react-dom"
  }
}

Proposed solution

I'm willing to create a PR that adds the correct directory metadata to the package.json files in the packages/package-names/ folders. But I'm opening this issue first to get approval for this idea. 😉

HonkingGoose avatar Jan 05 '22 21:01 HonkingGoose