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

package.json repository/directory metadata incomplete #3612

Closed
rarkins opened this issue Oct 20, 2020 · 5 comments · Fixed by #3613
Closed

package.json repository/directory metadata incomplete #3612

rarkins opened this issue Oct 20, 2020 · 5 comments · Fixed by #3613
Labels
bug An error in the Docusaurus core causing instability or issues with its execution

Comments

@rarkins
Copy link
Contributor

rarkins commented Oct 20, 2020

🐛 Bug Report

The package.json files within packages/* contain incomplete metadata for source repo and source directory. e.g. as according to this advice from npm's package.json documentation:

image

Have you read the [Contributing Guidelines on issues]

Yes

To Reproduce

View any package.json within packages/*. I think all are missing the directory field and some are also missing the source repository information altogether (e.g. @docusaurus/preset-classic)

Expected behavior

Monorepo package.json files should all contain a valid repository object including directory field.

I can try correcting this if you agree to receive a PR.

Actual Behavior

N/A

Your Environment

N/A

Reproducible Demo

N/A

@rarkins rarkins added bug An error in the Docusaurus core causing instability or issues with its execution status: needs triage This issue has not been triaged by maintainers labels Oct 20, 2020
@lex111
Copy link
Contributor

lex111 commented Oct 20, 2020

I can try correcting this if you agree to receive a PR.

Yes, of course, it would be great!

@slorber
Copy link
Collaborator

slorber commented Oct 20, 2020

Is this something new related to npm 7 support for workspace?

Or is it something that could improve the npm package links? for example on this page? https://www.npmjs.com/package/@docusaurus/core

@rarkins
Copy link
Contributor Author

rarkins commented Oct 20, 2020

@slorber it wasn't related to npm 7 specifically. I help run Renovate Bot and correct source URLs help us with both automated grouping as well as changelog retrieval. An example of one which is missing source links is https://www.npmjs.com/package/@docusaurus/preset-classic

@slorber
Copy link
Collaborator

slorber commented Oct 20, 2020

Thanks, I see. PR welcome ;)

Are you able to retrieve easily the changelogs, as we have v1 and v2 changelogs at the root?
We don't have a changelog per package.

We have an issue about Renovate Bot here, will have to check that and see how Docusaurus can benefit from it.
#3552

@rarkins
Copy link
Contributor Author

rarkins commented Oct 20, 2020

@slorber happy to help on that aspect too. Anyway, for now please see the linked PR #3613

@Josh-Cena Josh-Cena removed the status: needs triage This issue has not been triaged by maintainers label Mar 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An error in the Docusaurus core causing instability or issues with its execution
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants