Skip to content

Simplify repository element in npm's project.json to use https URL #1127

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Dec 3, 2020
Merged

Simplify repository element in npm's project.json to use https URL #1127

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
514ec66
Simplify repository element to use https URL
jcansdale Nov 6, 2020
c3616f2
Update content/packages/using-github-packages-with-your-projects-ecos…
jcansdale Nov 6, 2020
a734791
Make spacing of ":" consistent with "publishConfig"
jcansdale Nov 9, 2020
cc4b5d6
Merge branch 'main' into repository-https
runleonarun Dec 3, 2020
7c69169
Merge branch 'main' into repository-https
runleonarun Dec 3, 2020
be8179c
Merge branch 'main' into repository-https
janiceilene Dec 3, 2020
39b1dc6
Merge branch 'main' into repository-https
janiceilene Dec 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions ...es-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,10 @@ To publish multiple packages to the same repository, you can include the URL of

To ensure the repository's URL is correct, replace REPOSITORY with the name of the repository containing the package you want to publish, and OWNER with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository.

{% data variables.product.prodname_registry %} will match the repository based on the URL, instead of based on the package name. If you store the *package.json* file outside the root directory of your repository, you can use the `directory` field to specify the location where {% data variables.product.prodname_registry %} can find the *package.json* files.
{% data variables.product.prodname_registry %} will match the repository based on the URL, instead of based on the package name.

```shell
"repository" : {
"type" : "git",
"url": "ssh://git@{% if currentVersion == "free-pro-team@latest" %}github.com{% else %}<em>HOSTNAME</em>{% endif %}/<em>OWNER</em>/<em>REPOSITORY</em>.git",
"directory": "packages/name"
Copy link
Contributor

Choose a reason for hiding this comment

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

It explains the "directory" value in the previous paragraph

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch! I don't think we need to document the directory value here (it isn't used by GitHub Packages).

},
"repository":"https://{% if currentVersion == "free-pro-team@latest" %}github.com{% else %}<em>HOSTNAME</em>{% endif %}/<em>OWNER</em>/<em>REPOSITORY</em>",
```

### Installing a package
Expand Down