Pact.PactVerifier.ConsumerVersionSelector (pact_verifier_ex v0.1.6)

Copy Markdown

Structure to represent a consumer version selector for filtering pacts to verify.

Fields

  • consumer - Application name to filter the results on. Allows a selector to only be applied to a certain consumer.
  • tag - Tag name(s) of the consumer versions to get the pacts for. Recommended to use branch in preference now.
  • fallback_tag - Fallback tag if tag doesn’t exist. Name of the tag to fallback to if the specified tag does not exist.
  • latest - Only select the latest (if false, selects all pacts for a tag). Used with the tag property.
  • deployed_or_released - Applications that have been deployed or released. Returns pacts for all versions of the consumer that are currently deployed or released and supported in any environment.
  • deployed - Applications that have been deployed. Returns pacts for all versions of the consumer that are currently deployed to any environment.
  • released - Applications that have been released. Returns pacts for all versions of the consumer that are released and currently supported in any environment.
  • environment - Name of the environment containing the consumer versions for which to return the pacts.
  • main_branch - Applications with the default branch set in the broker. Returns pacts for the configured mainBranch of each consumer.
  • branch - Branch name of the consumer versions to get the pacts for.
  • matching_branch - Applications that match the provider version branch sent during verification. When true, returns the latest pact for any branch with the same name as the specified provider_version_branch.
  • fallback_branch - Fallback branch if branch doesn’t exist. Name of the branch to fallback to if the specified branch does not exist.

Summary

Types

t()

Types

t()

@type t() :: %Pact.PactVerifier.ConsumerVersionSelector{
  branch: nil | String.t(),
  consumer: nil | String.t(),
  deployed: nil | boolean(),
  deployed_or_released: nil | boolean(),
  environment: nil | String.t(),
  fallback_branch: nil | String.t(),
  fallback_tag: nil | String.t(),
  latest: nil | boolean(),
  main_branch: nil | boolean(),
  matching_branch: nil | boolean(),
  released: nil | boolean(),
  tag: nil | String.t()
}