!git.url

The !git.url Atmos YAML function returns the origin remote URL of the current Git repository — for example, https://github.com/cloudposse/atmos.git. It works for GitHub, GitLab, Bitbucket, and Azure DevOps.

Usage

  # Get the repository remote URL.
  # If the repository cannot be resolved, it returns a default value if specified; otherwise, it returns an error.
  !git.url <default-value>

Examples

vars:
  git_url: !git.url

  # With a fallback value when there is no remote.
  git_url_safe: !git.url https://github.com/my-org/my-repo.git

Related Functions

• !git.repository — the full <owner>/<name> slug
• !git.owner — the repository owner / organization
• !git.name — the bare repository name
• !git.host — the repository host (e.g. github.com)
• !git.sha — the current commit SHA