bb25f85ce8
This was intended to be a small followup for https://github.com/go-gitea/gitea/pull/23712, but...here we are. 1. Our docs currently use `slug` as the entire URL, which makes refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712). Instead, this PR attempts to make future refactoring easier by using slugs as an extension of the section. (Hugo terminology) - What the above boils down to is this PR attempts to use directory organization as URL management. e.g. `usage/comparison.en-us.md` -> `en-us/usage/comparison/`, `usage/packages/overview.en-us.md` -> `en-us/usage/packages/overview/` - Technically we could even remove `slug`, as Hugo defaults to using filename, however at least with this PR it means `slug` only needs to be the name for the **current file** rather than an entire URL 2. This PR adds appropriate aliases (redirects) for pages, so anything on the internet that links to our docs should hopefully not break. 3. A minor nit I've had for a while, renaming `seek-help` to `support`. It's a minor thing, but `seek-help` has a strange connotation to it. 4. The commits are split such that you can review the first which is the "actual" change, and the second is added redirects so that the first doesn't break links elsewhere. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
3.5 KiB
| date | title | slug | weight | draft | toc | menu | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2021-07-20T00:00:00+00:00 | npm Packages Repository | npm | 70 | false | false |
|
npm Packages Repository
Publish npm packages for your user or organization.
Table of Contents
{{< toc >}}
Requirements
To work with the npm package registry, you need Node.js coupled with a package manager such as Yarn or npm itself.
The registry supports scoped and unscoped packages.
The following examples use the npm tool with the scope @test.
Configuring the package registry
To register the package registry you need to configure a new package source.
npm config set {scope}:registry https://gitea.example.com/api/packages/{owner}/npm/
npm config set -- '//gitea.example.com/api/packages/{owner}/npm/:_authToken' "{token}"
| Parameter | Description |
|---|---|
scope |
The scope of the packages. |
owner |
The owner of the package. |
token |
Your [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}). |
For example:
npm config set @test:registry https://gitea.example.com/api/packages/testuser/npm/
npm config set -- '//gitea.example.com/api/packages/testuser/npm/:_authToken' "personal_access_token"
or without scope:
npm config set registry https://gitea.example.com/api/packages/testuser/npm/
npm config set -- '//gitea.example.com/api/packages/testuser/npm/:_authToken' "personal_access_token"
Publish a package
Publish a package by running the following command in your project:
npm publish
You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.
Unpublish a package
Delete a package by running the following command:
npm unpublish {package_name}[@{package_version}]
| Parameter | Description |
|---|---|
package_name |
The package name. |
package_version |
The package version. |
For example:
npm unpublish @test/test_package
npm unpublish @test/test_package@1.0.0
Install a package
To install a package from the package registry, execute the following command:
npm install {package_name}
| Parameter | Description |
|---|---|
package_name |
The package name. |
For example:
npm install @test/test_package
Tag a package
The registry supports version tags which can be managed by npm dist-tag:
npm dist-tag add {package_name}@{version} {tag}
| Parameter | Description |
|---|---|
package_name |
The package name. |
version |
The version of the package. |
tag |
The tag name. |
For example:
npm dist-tag add test_package@1.0.2 release
The tag name must not be a valid version. All tag names which are parsable as a version are rejected.
Search packages
The registry supports searching but does not support special search qualifiers like author:gitea.
Supported commands
npm install
npm ci
npm publish
npm unpublish
npm dist-tag
npm view
npm search