Commit aecd2779 authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'sabrams-master-patch-37881' into 'master'

Fix NPM name format typos

See merge request gitlab-org/gitlab!50797
parents 3972af21 8a869177
...@@ -102,7 +102,7 @@ To authenticate to the Package Registry, you must use one of the following: ...@@ -102,7 +102,7 @@ To authenticate to the Package Registry, you must use one of the following:
- It's not recommended, but you can use [OAuth tokens](../../../api/oauth2.md#resource-owner-password-credentials-flow). - It's not recommended, but you can use [OAuth tokens](../../../api/oauth2.md#resource-owner-password-credentials-flow).
Standard OAuth tokens cannot authenticate to the GitLab NPM Registry. You must use a personal access token with OAuth headers. Standard OAuth tokens cannot authenticate to the GitLab NPM Registry. You must use a personal access token with OAuth headers.
- A [CI job token](#authenticate-with-a-ci-job-token). - A [CI job token](#authenticate-with-a-ci-job-token).
- Your NPM package name must be in the format of [@scope:package-name](#package-naming-convention). It must match exactly, including the case. - Your NPM package name must be in the format of [@scope/package-name](#package-naming-convention). It must match exactly, including the case.
### Authenticate with a personal access token or deploy token ### Authenticate with a personal access token or deploy token
...@@ -201,7 +201,7 @@ Then, you can run `npm publish` either locally or by using GitLab CI/CD. ...@@ -201,7 +201,7 @@ Then, you can run `npm publish` either locally or by using GitLab CI/CD.
## Package naming convention ## Package naming convention
Your NPM package name must be in the format of `@scope:package-name`. Your NPM package name must be in the format of `@scope/package-name`.
- The `@scope` is the root namespace of the GitLab project. It must match exactly, including the case. - The `@scope` is the root namespace of the GitLab project. It must match exactly, including the case.
- The `package-name` can be whatever you want. - The `package-name` can be whatever you want.
...@@ -241,7 +241,7 @@ Prerequisites: ...@@ -241,7 +241,7 @@ Prerequisites:
- [Authenticate](#authenticate-to-the-package-registry) to the Package Registry. - [Authenticate](#authenticate-to-the-package-registry) to the Package Registry.
- Set a [project-level NPM endpoint](#use-the-gitlab-endpoint-for-npm-packages). - Set a [project-level NPM endpoint](#use-the-gitlab-endpoint-for-npm-packages).
- Your NPM package name must be in the format of [@scope:package-name](#package-naming-convention). It must match exactly, including the case. - Your NPM package name must be in the format of [@scope/package-name](#package-naming-convention). It must match exactly, including the case.
To upload an NPM package to your project, run this command: To upload an NPM package to your project, run this command:
...@@ -461,7 +461,7 @@ If you get this error, ensure that: ...@@ -461,7 +461,7 @@ If you get this error, ensure that:
### `npm publish` returns `npm ERR! 400 Bad Request` ### `npm publish` returns `npm ERR! 400 Bad Request`
If you get this error, your package name may not meet the If you get this error, your package name may not meet the
[@scope:package-name package naming convention](#package-naming-convention). [@scope/package-name package naming convention](#package-naming-convention).
Ensure the name meets the convention exactly, including the case. Ensure the name meets the convention exactly, including the case.
Then try to publish again. Then try to publish again.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment