Skip to main content

PURL Type Definition: github

  • Type Name: GitHub
  • Description: GitHub-based packages
  • Schema ID: https://packageurl.org/types/github-definition.json

PURL Syntax​

The structure of a PURL for this package type is:

pkg:github/<namespace>/<name>@<version>?<qualifiers>#<subpath>

Repository Information​

Namespace definition​

  • Requirement: Required
  • Native Label: user or organization
  • Note: The namespace is the user or organization. It is not case sensitive and must be lowercased.

Name definition​

  • Requirement: Required
  • Native Label: repository name
  • Note: The name is the repository name. It is not case sensitive and must be lowercased.

Version definition​

  • Requirement: Optional
  • Native Label: commit or tag
  • Note: The version is a commit or tag.

Examples​

  • pkg:github/package-url/purl-spec@244fd47e07d1004
  • pkg:github/package-url/purl-spec@244fd47e07d1004#everybody/loves/dogs