Processor GitHubReleasesInfoProvider

GitHubReleasesInfoProvider

NOTE: This page is automatically generated by GitHub Actions when a new release is tagged.
Updates to the information on this page should be submitted as pull requests to the AutoPkg repository. Processors are located here.

Description

Get metadata from the latest release from a GitHub project using the GitHub Releases API. Requires version 0.5.0.

Input Variables

• asset_regex:
  • required: False
  • description: If set, return only a release asset that matches this regex.
• github_repo:
  • required: True
  • description: Name of a GitHub user and repo, ie. 'MagerValp/AutoDMG'
• include_prereleases:
  • required: False
  • description: If set to True or a non-empty value, include prereleases.
• latest_only:
  • required: False
  • description: If True or a non-empty value, API call will fetch only the release marked as 'latest' in GitHub. May not play well with 'include_prereleases'.
• sort_by_highest_tag_names:
  • required: False
  • description: Set this to have releases sorted by highest to lowest tag version. By default, releases are sorted descending by date posted. This changes this behavior for cases where an 'older' release may be posted later.
• curl_opts:
  • required: False
  • description: Optional array of curl options to include with the download request.
• CURL_PATH:
  • required: False
  • default: /usr/bin/curl
  • description: Path to curl binary. Defaults to /usr/bin/curl.
• GITHUB_URL:
  • required: False
  • default: https://api.github.com
  • description: If your organization has an internal GitHub instance set this value to your internal GitHub URL ie. 'https://git.internal.corp.com/api/v3'
• GITHUB_TOKEN_PATH:
  • required: False
  • default: ~/.autopkg_gh_token
  • description: Path to a file containing your GitHub token. Can be a relative path or absolute path. ie. '~/.custom_gh_token' or '/path/to/token' NOTE: the AutoPkg preference 'GITHUB_TOKEN' takes precedence over this value.

Output Variables

• release_notes:
  • description: Full release notes body text from the chosen release.
• url:
  • description: URL for the first asset found for the project's latest release.
• asset_url:
  • description: The asset URL for the project's latest release. This is an API-only URL distinct from the browser_download_url, and is required for programmatically downloading assets from private repositories.
• version:
  • description: Version info parsed, naively derived from the release's tag.
• asset_created_at:
  • description: The release time of the asset.