Package loader specifications

Release fields

Here is an overview of the fields (+ internal version name + branch name) used by each package loader, after D6616:

Fields used by each package loader

Loader	internal version	branch name	name	message	synthetic	author	date	Notes
arch	p_info.​version	release_name(​version, filename)	=version	Synthetic release for Arch Linux source package {p_info.name} version {p_info.version} {description}	true	from intrinsic metadata	from extra_loader_arguments[‘arch_metadata’]	Intrinsic metadata extracted from .PKGINFO file of the package
archive	passed as arg	release_name(​version)	=version	“Synthetic release for archive at {p_info.url}n”	true	“”	passed as arg
aur	p_info.​version	release_name(​version, filename)	=version	Synthetic release for Aur source package {p_info.name} version {p_info.version} {description}	true	“”	from extra_loader_arguments[‘aur_metadata’]	Intrinsic metadata extracted from .SRCINFO file of the package
cpan	p_info.​version	release_name(​version)	=version	Synthetic release for Perl source package {name} version {version} {description}	true	from intrinsic metadata if any else from extrinsic	from extrinsic metadata	name, version and description from intrinsic metadata
cran	metadata.get(​"Version", passed as arg)	release_name(​version)	=version	standard message	true	metadata.get(​"Maintainer", "")	metadata.get(​"Date")	metadata is intrinsic
conda	p_info.​version	release_name(​version)	=version	Synthetic release for Conda source package {p_info.name} version {p_info.version}	true	from intrinsic metadata	from extrinsic metadata	“”
crates	p_info.​version	release_name(​version, filename) + "\n\n" + i_metadata.description + "\n"	=version	Synthetic release for Crate source package {p_info.name} version {p_info.version} {description}	true	from int metadata	from ext metadata	i_metadata for intrinsic metadata, e_metadata for extrinsic metadata
debian	=``version``	release_name(​version)	=``i_version``	standard message (using i_version)	true	metadata​.changelog​.person	metadata​.changelog​.date	metadata is intrinsic. Old revisions have dsc as type i_version is the intrinsic version (eg. 0.7.2-3) while version contains the debian suite name (eg. stretch/contrib/0.7.2-3) and is passed as arg
golang	p_info.​version	release_name(version)	=version	Synthetic release for Golang source package {p_info.name} version {p_info.version}	true	“”	from ext metadata	Golang offers basically no metadata outside of version and timestamp
deposit	HEAD	only HEAD	HEAD	“{client}: Deposit {id} in collection {collection}n”	true	original author	<codemeta: dateCreated> from SWORD XML	revisions had parents
hackage	p_info.​version	release_name(​version)	=version	Synthetic release for Haskell source package {p_info.name} version {p_info.version}	true	intrinsic metadata if any else from extrinsic metadata	from extrinsic metadata	“”
hex	p_info.version	release_name(version)	=version	standard message	true	from extrinsic metadata	from extrinsic metadata	Source code is extracted from a nested tarball
maven-loader	passed as arg	HEAD	release_name(version)	“Synthetic release for archive at {p_info.url}n”	true	“”	passed as arg	Only one artefact per url (jar/zip src)
npm	metadata​["version"]	release_name(​version)	=version	standard message	true	from int metadata or “”	from ext metadata or None
opam	as given by opam	“{opam_package}​.{version}”	=version	standard message	true	from metadata	None	“{self.opam_package}​.{version}” matches the version names used by opam’s backend. metadata is extrinsic
pubdev	p_info.​version	release_name(​version)	=version	Synthetic release for pub.dev source package {p_info.name} version {p_info.version}	true	from extrinsic metadata	from extrinsic metadata	name and version from extrinsic metadata
puppet	p_info.​version	release_name(​version)	=version	Synthetic release for Puppet source package {p_info.name} version {version} {description}	true	from intrinsic metadata	from extrinsic metadata	version and description from intrinsic metadata
pypi	metadata​["version"]	release_name(​version) or release_name(​version, filename)	=version	metadata[​'comment_text']} or standard message	true	from int metadata or “”	from ext metadata or None	metadata is intrinsic
rubygems	p_info.version	release_name(​version)	=version	Synthetic release for RubyGems source package {p_info.name} version {p_info.version}	true	from ext metadata	from ext metadata	The source code is extracted from a tarball nested within the gem file

using this function:

def release_name(version: str, filename: Optional[str] = None) -> str:
    if filename:
        return "releases/%s/%s" % (version, filename)
    return "releases/%s" % version

and “standard message” being:

msg = (
    f"Synthetic release for {PACKAGE_MANAGER} source package {name} "
    f"version {version}\n"
)

The target_type field is always dir, and the target the id of a directory loaded by unpacking a tarball/zip file/…