Changeset View
Changeset View
Standalone View
Standalone View
docs/package-loader-specifications.rst
| Show All 18 Lines | * - Loader | ||||
| - synthetic | - synthetic | ||||
| - author | - author | ||||
| - date | - date | ||||
| - Notes | - Notes | ||||
| * - archive | * - archive | ||||
| - passed as arg | - passed as arg | ||||
| - ``release_name(!version)`` | - ``release_name(!version)`` | ||||
| - =version | - =version | ||||
| - "swh-loader-package: | - "Synthetic release for archive at {p_info.url}" | ||||
| synthetic revision message" | |||||
| - true | - true | ||||
| - SWH robot | - "" | ||||
| - passed as arg | - passed as arg | ||||
| - | - | ||||
| * - cran | * - cran | ||||
| - ``metadata.get(!"Version", passed as arg)`` | - ``metadata.get(!"Version", passed as arg)`` | ||||
| - ``release_name(!version)`` | - ``release_name(!version)`` | ||||
| - =version | - =version | ||||
| - =version | - standard message | ||||
| - true | - true | ||||
| - ``metadata.get(!"Maintainer", "")`` | - ``metadata.get(!"Maintainer", "")`` | ||||
| - ``metadata.get(!"Date")`` | - ``metadata.get(!"Date")`` | ||||
| - metadata is intrinsic | - metadata is intrinsic | ||||
| * - debian | * - debian | ||||
| - passed as arg (eg. ``stretch/contrib/0.7.2-3``) | - passed as arg (eg. ``stretch/contrib/0.7.2-3``) | ||||
| - ``release_name(!version)`` | - ``release_name(!version)`` | ||||
| - =version | - =version | ||||
| - "Synthetic revision for Debian source package %s version %s" | - standard message (using full version) | ||||
| - true | - true | ||||
| - ``metadata!.changelog!.person`` | - ``metadata!.changelog!.person`` | ||||
| - ``metadata!.changelog!.date`` | - ``metadata!.changelog!.date`` | ||||
| - metadata is intrinsic. Old revisions have ``dsc`` as type | - metadata is intrinsic. Old revisions have ``dsc`` as type | ||||
| * - deposit | * - deposit | ||||
| - HEAD | - HEAD | ||||
| - only HEAD | - only HEAD | ||||
| - HEAD | - HEAD | ||||
| - "{client}: Deposit {id} in collection {collection}" | - "{client}: Deposit {id} in collection {collection}" | ||||
| - true | - true | ||||
| - SWH robot | - original author | ||||
| - ``<codemeta: dateCreated>`` from SWORD XML | - ``<codemeta: dateCreated>`` from SWORD XML | ||||
| - revisions had parents | - revisions had parents | ||||
| * - nixguix | * - nixguix | ||||
| - URL | - URL | ||||
| - URL | - URL | ||||
| - URL | - URL | ||||
| - "" | - None | ||||
| - true | - true | ||||
| - "" | - "" | ||||
| - None | - None | ||||
| - it's the URL of the artifact referenced by the derivation | - it's the URL of the artifact referenced by the derivation | ||||
| * - npm | * - npm | ||||
| - ``metadata!["version"]`` | - ``metadata!["version"]`` | ||||
| - ``release_name(!version)`` | - ``release_name(!version)`` | ||||
| - =version | - =version | ||||
| - =version | - standard message | ||||
| - true | - true | ||||
| - from int metadata or "" | - from int metadata or "" | ||||
| - from ext metadata or None | - from ext metadata or None | ||||
| - | - | ||||
| * - opam | * - opam | ||||
| - as given by opam | - as given by opam | ||||
| - "{opam_package}!.{version}" | - "{opam_package}!.{version}" | ||||
| - =version | - =version | ||||
| - =version | - standard message | ||||
| - true | - true | ||||
| - from metadata | - from metadata | ||||
| - None | - None | ||||
| - "{self.opam_package}!.{version}" matches the version names used by opam's backend. metadata is extrinsic | - "{self.opam_package}!.{version}" matches the version names used by opam's backend. metadata is extrinsic | ||||
| * - pypi | * - pypi | ||||
| - ``metadata!["version"]`` | - ``metadata!["version"]`` | ||||
| - ``release_name(!version)`` or ``release_name(!version, filename)`` | - ``release_name(!version)`` or ``release_name(!version, filename)`` | ||||
| - =version | - =version | ||||
| - "{version}: {metadata[!'comment_text']}" or just version | - ``metadata[!'comment_text']}`` or standard message | ||||
| - true | - true | ||||
| - from int metadata or "" | - from int metadata or "" | ||||
| - from ext metadata or None | - from ext metadata or None | ||||
| - metadata is intrinsic | - metadata is intrinsic | ||||
| using this function:: | using this function:: | ||||
| def release_name(version: str, filename: Optional[str] = None) -> str: | def release_name(version: str, filename: Optional[str] = None) -> str: | ||||
| if filename: | if filename: | ||||
| return "releases/%s/%s" % (version, filename) | return "releases/%s/%s" % (version, filename) | ||||
| return "releases/%s" % version | return "releases/%s" % version | ||||
| and "standard message" being:: | |||||
| msg = ( | |||||
| f"Synthetic release for {PACKAGE_MANAGER} source package {name} " | |||||
| f"version {version}" | |||||
| ) | |||||
| The ``target_type`` field is always ``dir``, and the target the id of a directory | The ``target_type`` field is always ``dir``, and the target the id of a directory | ||||
| loaded by unpacking a tarball/zip file/... | loaded by unpacking a tarball/zip file/... | ||||