% This work is marked CC0 1.0 Universal.  To view a copy of this mark,
% visit https://creativecommons.org/publicdomain/zero/1.0/.
%
% NOTE: Keep documentation in sync with bashbrew-build/action.yaml.
% Synchronize input descriptions with the corresponding `matrix.runs`
% property descriptions in the `strategy` output of the bashbrew-jobs
% action, as well.

# bashbrew-build

> Build and test a Docker container image.

Execute the strategy generated by [](bashbrew-jobs).  This action
skips unspecified steps without raising an error.

Uploading the built image to a container registry is the
responsibility of the caller.

## Inputs

:prepare: (default value: `"true"`)

  This sets up the run-time environment.

  ---

:pull: (default value: `"true"`)

  This specifies the build dependencies to download.

  ---

:build: (default value: `"true"`)

  Build and tag the container image with these commands.

  ---

:history: (default value: `"true"`)

  These commands pretty-print the container image's build history for
  later review.

  ---

:test: (default value: `"true"`)

  This procedure tests the container image.

  ---

:images: (default value: `"true"`)

  This lists the image tag(s) created by this job.

  ---

:access-app-id: Provide the app ID of a GitHub App used to access
  private repositories.  When
  [registering the app](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app)
  in the organization, disable webhook functionality and grant
  **read-only**
  [repository permissions for "Contents"](https://docs.github.com/en/rest/authentication/permissions-required-for-github-apps#repository-permissions-for-contents).
  After completing app registration,
  [generate a private key](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)
  and install the app, giving it access to selected repositories as
  appropriate.

  ---

:access-key: Log into the GitHub App used to access private
  repositories with this
  [private key](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps).

  ---

:owner: Access private repositories owned by this GitHub account or
  organization, overriding
  [github.repository_owner](https://docs.github.com/en/actions/reference/workflows-and-actions/contexts#github-context).