Differential D6618 Diff 24065 docs/package-loader-specifications.rst

Changeset View

Standalone View

View Options

docs/package-loader-specifications.rst

This file was added.

.. _package-loader-specifications:

Package loader specifications

=============================

Release fields

--------------

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

.. list-table:: Fields used by each package loader

:header-rows: 1

* - Loader

- internal version

- branch name

- name

- message

- synthetic

- author

- date

- Notes

* - archive

- passed as arg

- ``release_name(!version)``

- =version

- "swh-loader-package:

synthetic revision message"

- true

- SWH robot

- passed as arg

* - cran

- ``metadata.get(!"Version", passed as arg)``

- ``release_name(!version)``

ardumontUnsubmitted

Done

- ``metadata.get( "Version", passed as arg)``

- - ``release_name( version)``

+ - ``release_name(version)``

- =version

ardumont:

vlorentzAuthorUnsubmitted

Done

that's by design to let the browser reflow; the table is uncomfortable large otherwise.

I should probably replace it with a ZWS, though...

vlorentz: that's by design to let the browser reflow; the table is uncomfortable large otherwise. I…

vlorentzAuthorUnsubmitted

Done

Ah, I see the misunderstanding. This is what the table looks like for me, with JS disabled:

vlorentz: Ah, I see the misunderstanding. This is what the table looks like for me, with JS disabled…

- =version

- true

- ``metadata.get(!"Maintainer", "")``

- ``metadata.get(!"Date")``

- metadata is intrinsic

* - debian

- passed as arg (eg. ``stretch/contrib/0.7.2-3``)

- ``release_name(!version)``

ardumontUnsubmitted

Done

- passed as arg (eg. ``stretch/contrib/0.7.2-3``)

- - release_name( version)

+ - ``release_name(version)``

- =version

ardumont:

- =version

- "Synthetic revision for Debian source package %s version %s"

- true

- ``metadata!.changelog!.person``

- ``metadata!.changelog!.date``

- metadata is intrinsic. Old revisions have ``dsc`` as type

* - deposit

- HEAD

- only HEAD

- HEAD

- "{client}: Deposit {id} in collection {collection}"

- true

- SWH robot

- ``<codemeta: dateCreated>`` from SWORD XML

- revisions had parents

* - nixguix

- URL

- ""

- true

- ""

- None

- it's the URL of the artifact referenced by the derivation

* - npm

- ``metadata!["version"]``

- ``release_name(!version)``

ardumontUnsubmitted

Done

- ``metadata["version"]``

- - release_name( version)

+ - ``release_name(version)``

- =version

ardumont:

- =version

- true

- from int metadata or ""

- from ext metadata or None

* - opam

- as given by opam

- "{opam_package}!.{version}"

- =version

- true

- from metadata

- None

- "{self.opam_package}!.{version}" matches the version names used by opam's backend. metadata is extrinsic

* - pypi

- ``metadata!["version"]``

- ``release_name(!version)`` or ``release_name(!version, filename)``

- =version

- "{version}: {metadata[!'comment_text']}" or just version

- true

- from int metadata or ""

- from ext metadata or None

- metadata is intrinsic

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

The ``target_type`` field is always ``dir``, and the target the id of a directory

loaded by unpacking a tarball/zip file/...