# ivuorinen/actions/docker-publish-gh

## Docker Publish to GitHub Packages

### Description

Publishes a Docker image to GitHub Packages with advanced security and reliability features.

### Inputs

| name          | description                                                                      | required | default                   |
|---------------|----------------------------------------------------------------------------------|----------|---------------------------|
| `image-name`  | <p>The name of the Docker image to publish. Defaults to the repository name.</p> | `false`  | `""`                      |
| `tags`        | <p>Comma-separated list of tags for the Docker image.</p>                        | `true`   | `""`                      |
| `platforms`   | <p>Platforms to publish (comma-separated). Defaults to amd64 and arm64.</p>      | `false`  | `linux/amd64,linux/arm64` |
| `registry`    | <p>GitHub Container Registry URL</p>                                             | `false`  | `ghcr.io`                 |
| `token`       | <p>GitHub token with package write permissions</p>                               | `false`  | `${{ github.token }}`     |
| `provenance`  | <p>Enable SLSA provenance generation</p>                                         | `false`  | `true`                    |
| `sbom`        | <p>Generate Software Bill of Materials</p>                                       | `false`  | `true`                    |
| `max-retries` | <p>Maximum number of retry attempts for publishing</p>                           | `false`  | `3`                       |
| `retry-delay` | <p>Delay in seconds between retries</p>                                          | `false`  | `10`                      |

### Outputs

| name         | description                               |
|--------------|-------------------------------------------|
| `image-name` | <p>Full image name including registry</p> |
| `digest`     | <p>The digest of the published image</p>  |
| `tags`       | <p>List of published tags</p>             |
| `provenance` | <p>SLSA provenance attestation</p>        |
| `sbom`       | <p>SBOM document location</p>             |

### Runs

This action is a `composite` action.

### Usage

```yaml
- uses: ivuorinen/actions/docker-publish-gh@main
  with:
    image-name:
    # The name of the Docker image to publish. Defaults to the repository name.
    #
    # Required: false
    # Default: ""

    tags:
    # Comma-separated list of tags for the Docker image.
    #
    # Required: true
    # Default: ""

    platforms:
    # Platforms to publish (comma-separated). Defaults to amd64 and arm64.
    #
    # Required: false
    # Default: linux/amd64,linux/arm64

    registry:
    # GitHub Container Registry URL
    #
    # Required: false
    # Default: ghcr.io

    token:
    # GitHub token with package write permissions
    #
    # Required: false
    # Default: ${{ github.token }}

    provenance:
    # Enable SLSA provenance generation
    #
    # Required: false
    # Default: true

    sbom:
    # Generate Software Bill of Materials
    #
    # Required: false
    # Default: true

    max-retries:
    # Maximum number of retry attempts for publishing
    #
    # Required: false
    # Default: 3

    retry-delay:
    # Delay in seconds between retries
    #
    # Required: false
    # Default: 10
```