Scroll to navigation

USCAN-TEMPLATES(5) USCAN-TEMPLATES(5)

NAME

uscan-templates - Available templates for uscan(1).

USING TEMPLATES

Templates simplify the debian/watch file. You just have to indicate the template to use and the specific arguments. Example:

  Version: 5
  Template: GitHub
  Owner: guimard
  Project: llng-docker

Other parameters can be added as usual. Example:

  Version: 5
  Template: GitHub
  Owner: guimard
  Project: llng-docker
  Version-Mangle: auto

AVAILABLE TEMPLATES

Here is the list of available templates:

  • "GitHub"
  • "Metacpan"
  • "Npmregistry"
  • GitLab
  • Pypi

GitHub

This template uses GitHub API to find archives to download.

Specific parameters

  • Owner <owner>
  • Project <project>
  • Release-Only <yes>: when set, search only in "/release" instead of "/tags"
  • Version-Type (default: ANY_VERSION): by default, templates use ANY_VERSION macro to find valid version. You can override this here using a valid macro name (ANY_VERSION or STABLE_VERSION or SEMANTIC_VERSION)

Example

Example for https://github.com/guimard/llng-docker:

  Version: 5
  Template: GitHub
  Owner: guimard
  Project: llng-docker

Metacpan

This template uses MetaCPAN::Client(3pm) to download package.

Specific parameters

  • Dist: distribution name (with "::" or "-")
  • Version-Type (default: ANY_VERSION): by default, templates use ANY_VERSION macro to find valid version. You can override this here using a valid macro name (ANY_VERSION or STABLE_VERSION or SEMANTIC_VERSION)

Example

  Version: 5
  Template: Metacpan
  Dist: MetaCPAN-Client

Npmregistry

This template just replaces:

  Version: 5
  Template: Npmregistry
  Dist: @lemonldapng/handler

by:

  Version: 5
  Source: https://registry.npmjs.org/@lemonldapng/handler
  Matching-Pattern: https://registry.npmjs.org/@lemonldapng/handler/-/handler-@ANY_VERSION@@ARCHIVE_EXT@
  Search-Mode: plain

Specific parameters

  • Dist: distribution name
  • Version-Type (default: ANY_VERSION): by default, templates use ANY_VERSION macro to find valid version. You can override this here using a valid macro name (ANY_VERSION or STABLE_VERSION or SEMANTIC_VERSION)

GitLab

This template uses Mode: gitlab to download package.

Specific parameters

  • Dist: URL to the project
  • Release-Only <yes>: when set, search only in "/release" instead of "/tags"
  • Version-Type (default: ANY_VERSION): by default, templates use ANY_VERSION macro to find valid version. You can override this here using a valid macro name (ANY_VERSION or STABLE_VERSION or SEMANTIC_VERSION)

Example

  Version: 5
  Template: GitLab
  Dist: https://salsa.debian.org/debian/devscripts

Pypi

This template uses pypi.debian.net to download the tarball.

Specific parameters

  • Dist: name of the project
  • Version-Type (default: ANY_VERSION): by default, templates use ANY_VERSION macro to find valid version. You can override this here using a valid macro name (ANY_VERSION or STABLE_VERSION or SEMANTIC_VERSION)

Example

  Version: 5
  Template: Pypi
  Dist: bitbox02

Adding templates

If you want to add a template in uscan, you can find the documentation here:

  $ perldoc /usr/share/perl5/Devscripts/Uscan/Templates.pod

Then build a merge-request into the devscripts project <https://salsa.debian.org/debian/devscripts>.

Authors

•
Xavier Guimard <yadd@debian.org>
2025-10-24 Debian Utilities