ocibuild_vcs_git (ocibuild v0.10.4)

View Source

Git adapter for OCI annotation support.

This module implements the ocibuild_vcs behaviour for Git repositories. It extracts source URL and revision information for OCI image annotations.

CI Environment Variables

For reliability in CI environments, this adapter checks environment variables before falling back to git commands:

Source URL (checked in order):

  1. GITHUB_SERVER_URL + GITHUB_REPOSITORY (GitHub Actions)
  2. CI_PROJECT_URL (GitLab CI)
  3. BUILD_REPOSITORY_URI (Azure DevOps)
  4. git remote get-url origin (fallback)

Revision (checked in order):

  1. GITHUB_SHA (GitHub Actions)
  2. CI_COMMIT_SHA (GitLab CI)
  3. BUILD_SOURCEVERSION (Azure DevOps)
  4. git rev-parse HEAD (fallback)

SSH to HTTPS Conversion

SSH URLs are automatically converted to HTTPS for public visibility:

  • git@github.com:org/repo.git → https://github.com/org/repo
  • ssh://git@github.com/org/repo.git → https://github.com/org/repo

Configuration

The timeout for git commands can be configured via environment variable:

  • OCIBUILD_GIT_TIMEOUT - Timeout in milliseconds (default: 5000, max: 300000)

This is particularly useful for network operations like git remote get-url when working with slow networks or remote repositories. Values above the maximum are clamped to 300000ms (5 minutes).

Summary

Functions

detect(Path)

Detect if Git VCS information is available.

get_revision(Path)

Get the current commit SHA.

get_source_url(Path)

Get the source repository URL.

Functions

detect(Path)

-spec detect(file:filename()) -> boolean().

Detect if Git VCS information is available.

Returns true if either:

  1. The path is within a Git repository (.git directory found), or
  2. CI environment variables are present (GITHUB_*, CI_PROJECT_URL, BUILD_REPOSITORY_URI)

This allows VCS annotations to work in CI environments where the build runs in a different directory than the repository checkout.

get_revision(Path)

-spec get_revision(file:filename()) -> {ok, binary()} | {error, term()}.

Get the current commit SHA.

Tries CI environment variables first, then falls back to git rev-parse HEAD.

get_source_url(Path)

-spec get_source_url(file:filename()) -> {ok, binary()} | {error, term()}.

Get the source repository URL.

Tries CI environment variables first, then falls back to git remote get-url origin. SSH URLs are converted to HTTPS.