Debian Upstream Metadata file

Debian packaging file for describing metadata about the upstream project

Type object
File match **/debian/upstream/metadata
Schema URL https://catalog.lintel.tools/schemas/schemastore/debian-upstream-metadata-file/latest.json
Source https://salsa.debian.org/debian/debian-json-schemas/-/raw/main/schemas/debian-upstream-metadata/debian-upstream-metadata-latest.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

Archive string

The name of the large archive that the upstream work is part of, like CPAN, GitHub, or GitLab.

ASCL-Id string

Identification code in the http://ascl.net (if known)

Bug-Database string

A URL to the list of known bugs for the project.

format=uripattern=^https?://
Bug-Submit string

A URL that is the place where new bug reports should be sent.

format=uripattern=^(https?://|mailto:)
Changelog string

URL to the upstream changelog.

format=uripattern=^https?://
Cite-As string

The way the authors want their software be cited in publications.

The value is a string which might contain a link in valid HTML syntax.

Contact string

Contact point for the upstream point.

Deprecated when using the machine readable format. The Upstream-Contact field in debian/copyright is the direct replacement in that case.

CPE string

One or more space separated http://cpe.mitre.org/ values useful to look up relevant CVEs in the https://nvd.nist.gov/home.cfm and other CVE sources.

See CPEtagPackagesDep for information on how this information can be used. Example: cpe:/a:ethereal_group:ethereal

Documentation string

A URL to the online documentation for the upstream project

format=uripattern=^https?://
Donation string

A URL for donating to the upstream project or free-text prose of instructions of how to do so

FAQ string

A URL to the FAQ if upstream provides one

format=uripattern=^https?://
Funding string | string[]
Name string

Contact point for the upstream point.

Deprecated when using the machine readable format. The Upstream-Name field in debian/copyright is the direct replacement in that case.

Other-References string

A URL to a upstream page containing more references.

format=uripattern=^https?://
Registration string

A URL to a registration form (or instructions). This could be registration of bug reporting accounts, registration for counting/contacting users etc.

format=uripattern=^https?://
Registry object[]

This field shall point to external catalogs/registries of software.

The field features an array of "Name (of registry) - Entry (ID of software in that catalog)" pairs. The names and entries shall only be names, not complete URIs, to avoid any bias on mirrors etc.

Reference

One or more bibliographic references. The key names map to the BibTeX entries.

Repository string

URL to a repository containing the upstream sources.

format=uripattern=^[^/\s]+://
Repository-Browser string

A URL to browse the repository containing the upstream sources.

format=uripattern=^https?://
Screenshots string | array
Security-Contact string

Which person, mailing list, forum, etc. to send security-related messages in the first place.

Webservice string

URL to a web page where the packaged program can also be used.

format=uripattern=^https?://