Commit 00369eba authored by Steve Abrams's avatar Steve Abrams Committed by Achilleas Pipinellis

NPM Registry docs new package naming convention

The documentation is updated to include details on the new
limitations and rules to naming NPM packages. A note is included
on how naming collisions are handled.
parent 9bcf5574
...@@ -11,11 +11,6 @@ project can have its own space to store NPM packages. ...@@ -11,11 +11,6 @@ project can have its own space to store NPM packages.
NOTE: **Note:** NOTE: **Note:**
Only [scoped](https://docs.npmjs.com/misc/scope) packages are supported. Only [scoped](https://docs.npmjs.com/misc/scope) packages are supported.
NOTE: **Note:**
As `@group/subgroup/project` is not a valid NPM package name, publishing a package
within a subgroup is not supported yet.
## Enabling the NPM Registry ## Enabling the NPM Registry
NOTE: **Note:** NOTE: **Note:**
...@@ -36,12 +31,15 @@ get familiar with the package naming convention. ...@@ -36,12 +31,15 @@ get familiar with the package naming convention.
## Package naming convention ## Package naming convention
**Only packages that have the same path as the project** are supported. For **Packages must be scoped in the root namespace of the project**. The package
example: name may be anything but it is preferred that the project name be used unless
it is not possible due to a naming collision. For example:
| Project | Package | Supported | | Project | Package | Supported |
| ---------------------- | ----------------------- | --------- | | ---------------------- | ----------------------- | --------- |
| `foo/bar` | `@foo/bar` | Yes | | `foo/bar` | `@foo/bar` | Yes |
| `foo/bar/baz` | `@foo/baz` | Yes |
| `foo/bar/buz` | `@foo/anything` | Yes |
| `gitlab-org/gitlab-ce` | `@gitlab-org/gitlab-ce` | Yes | | `gitlab-org/gitlab-ce` | `@gitlab-org/gitlab-ce` | Yes |
| `gitlab-org/gitlab-ce` | `@foo/bar` | No | | `gitlab-org/gitlab-ce` | `@foo/bar` | No |
...@@ -113,6 +111,9 @@ npm publish ...@@ -113,6 +111,9 @@ npm publish
You can then navigate to your project's **Packages** page and see the uploaded You can then navigate to your project's **Packages** page and see the uploaded
packages or even delete them. packages or even delete them.
If you attempt to publish a package with a name that already exists within
a given scope, you will receive a `403 Forbidden!` error.
## Uploading a package with the same version twice ## Uploading a package with the same version twice
If you upload a package with a same name and version twice, GitLab will show If you upload a package with a same name and version twice, GitLab will show
......
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