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

[jcansdale]

Why:

The repository element in the package.json file can be dramatically simplified from:

"repository" : {
"type" : "git",
"url": "ssh://git@github.com/OWNER/REPOSITORY.git",
"directory": "packages/name"
},

..to just:

"repository" : "https://github.com/OWNER/REPOSITORY",

This will be less error prone because it can be easily copy/pasted from GitHub repository URLs.

We could simplify it further to just "repository" : "OWNER/REPOSITORY",, because npm treats GitHub as it's default Git repository host. This would break symmetry with GHES, so maybe the https form is preferable?

See here for "repository" : "OWNER/REPOSITORY", form:
https://docs.npmjs.com/cli/v6/configuring-npm/package-json#repository:~:text=%22repository%22%3A%20%22npm%2Fnpm%22

What's being changed:

Check off the following:

• All of the tests are passing.
• I have reviewed my changes in staging.
• For content changes, I have reviewed the localization checklist
• For content changes, I have reviewed the Content style guide for GitHub Docs.

[nschonni]

It explains the "directory" value in the previous paragraph

[jcansdale]

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

[toddself]

This is different than how npm init configures the repository information if you have a git remote already configured, so it might potentially confusing?

[09:47:37] $ npm init -y
Wrote to /Users/toddkennedy/src/vimwiki/package.json:
{
"name": "vimwiki",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/toddself/vimwiki.git"
},
"keywords": [],
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/toddself/vimwiki/issues"
},
"homepage": "https://github.com/toddself/vimwiki#readme"
}

Ideally maybe we should say to use npm init (-y just accepts the default answers) to generate the package.json file? Then again I hate writing json by hand so it might be just me being lazy lol

[jcansdale]

@toddself,

This is different than how npm init configures the repository information if you have a git remote already configured, so it might potentially confusing?

Interesting, I didn't know that. I tend to npm init before git init.

I guess ssh://git@github.com/OWNER/REPOSITORY.git betrays the example was likely generated on a Mac, compared to https://github.com/OWNER/REPOSITORY which is more common for Windows users.

If I'm adding it by hand, I much prefer the "repository" : "https://github.com/OWNER/REPOSITORY", form. 🙂

[janiceilene]

👋 @jcansdale@toddself, let me know when this is ready for a writer review!

[jcansdale]

@toddself,

This is different than how npm init configures the repository information if you have a git remote already configured, so it might potentially confusing?

Thinking more about this. If a user does npm init inside an existing repository, the repository element will automatically be added and everything will just work.

I think the following section:

https://github.com/github/docs/blob/a73479193b2287ea49fe19ab44546d0895cf0a1f/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages.md#publishing-multiple-packages-to-the-same-repository

... is most relevant for users who are adding the repository element after the fact. In this case, I think the simplicity of a copy/pastable https element makes more sense.

What do you think?

[toddself]

@jcansdale i think that makes total sense!

[jcansdale]

@janiceilene I think we're ready for a writer review. 👍

[github-actions]

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

[jcansdale]

Hi @janiceilene, I've just marked this as not-stale. It's ready for a writer review. 🙂

[github-actions]

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

[runleonarun]

We will review this as soon as we can!

[runleonarun]

This looks good!

[github-actions]

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.