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

Change repository URL to package specific URL #339

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MarkAshraf96
Copy link

closes #335

Copy link

changeset-bot bot commented Oct 1, 2024

⚠️ No Changeset found

Latest commit: 252ef35

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Oct 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
proxy-agents ✅ Ready (Inspect) Visit Preview Oct 1, 2024 8:15am

Copy link
Collaborator

@lukekarrys lukekarrys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is preferred to use repository.directory to indicate a specific directory within a git repo: https://docs.npmjs.com/cli/v10/configuring-npm/package-json#repository

Also the url should point to something that can be passed to git clone. In this case the URLs have been updated to something that resolves in the browser but doesn't work with git:

❯ git clone https://github.com/TooTallNate/proxy-agents/tree/main/packages/agent-base
Cloning into 'agent-base'...
fatal: repository 'https://github.com/TooTallNate/proxy-agents/tree/main/packages/agent-base/' not found

@MarkAshraf96 do you have an example of a tool that works with the format you've changed it to here?

@MarkAshraf96
Copy link
Author

Some bigger monorepos, they prefer to have the URL indicating towards the package, specially if the packages are maintained separately.

But also maybe I can then modify the pull request to do it with repository.directory field.

@lukekarrys lukekarrys self-requested a review December 4, 2024 22:01
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

Successfully merging this pull request may close these issues.

Change repository URL to package specific URL
2 participants