gitea/docs/content/doc/packages/generic.en-us.md
Gergely Nagy 99f2f826ce
packages/generic: Do not restrict package versions to SemVer (#20414)
There are existing packages out there whose version do not conform to SemVer, yet, one would like to have them available in a generic package repository. To this end, remove the SemVer restriction on package versions when using the Generic package registry, and replace it with a check that simply makes sure the version isn't empty.

Signed-off-by: Gergely Nagy <me@gergo.csillger.hu>
Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
Co-authored-by: 6543 <6543@obermui.de>
2022-07-29 00:09:54 +02:00

2.8 KiB

date title slug draft toc menu
2021-07-20T00:00:00+00:00 Generic Packages Repository packages/generic false false
sidebar
parent name weight identifier
packages Generic 40 generic

Generic Packages Repository

Publish generic files, like release binaries or other output, for your user or organization.

Table of Contents

{{< toc >}}

Authenticate to the package registry

To authenticate to the Package Registry, you need to provide [custom HTTP headers or use HTTP Basic authentication]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}).

Publish a package

To publish a generic package perform a HTTP PUT operation with the package content in the request body. You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.

PUT https://gitea.example.com/api/packages/{owner}/generic/{package_name}/{package_version}/{file_name}
Parameter Description
owner The owner of the package.
package_name The package name. It can contain only lowercase letters (a-z), uppercase letter (A-Z), numbers (0-9), dots (.), hyphens (-), or underscores (_).
package_version The package version, a non-empty string.
file_name The filename. It can contain only lowercase letters (a-z), uppercase letter (A-Z), numbers (0-9), dots (.), hyphens (-), or underscores (_).

Example request using HTTP Basic authentication:

curl --user your_username:your_password_or_token \
     --upload-file path/to/file.bin \
     https://gitea.example.com/api/packages/testuser/generic/test_package/1.0.0/file.bin

The server reponds with the following HTTP Status codes.

HTTP Status Code Meaning
201 Created The package has been published.
400 Bad Request The package name and/or version are invalid or a package with the same name and version already exist.

Download a package

To download a generic package perform a HTTP GET operation.

GET https://gitea.example.com/api/packages/{owner}/generic/{package_name}/{package_version}/{file_name}
Parameter Description
owner The owner of the package.
package_name The package name.
package_version The package version.
file_name The filename.

The file content is served in the response body. The response content type is application/octet-stream.

Example request using HTTP Basic authentication:

curl --user your_username:your_token_or_password \
     https://gitea.example.com/api/packages/testuser/generic/test_package/1.0.0/file.bin