https://github.com/cytopia/docker-tag-action
GitHub Action to create Docker tag based on git branch or git tag
https://github.com/cytopia/docker-tag-action
Last synced: 2 months ago
JSON representation
GitHub Action to create Docker tag based on git branch or git tag
- Host: GitHub
- URL: https://github.com/cytopia/docker-tag-action
- Owner: cytopia
- License: mit
- Created: 2022-02-11T10:43:45.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-04T19:10:49.000Z (almost 2 years ago)
- Last Synced: 2025-03-13T10:38:05.510Z (3 months ago)
- Size: 66.4 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Docker tag action
[](https://github.com/cytopia/docker-tag-action/releases/latest)
[](https://github.com/marketplace/actions/docker-tag-action)
[](https://github.com/cytopia/docker-tag-action "github.com/cytopia/docker-tag-action")
[](https://github.com/cytopia/docker-tag-action/actions/workflows/test.yml)
This composite action determines the Docker tag based on what git branch, git tag or git commit you are on.
## :arrows_clockwise: Determination
The Docker tag output (`docker-tag`) of this action is determined in its default configuration as shown by the following table:
| Git state | Resulting Docker tag |
|--------------------|----------------------|
| On branch `master` | `latest` |
| On another branch | `` |
| On a tag | `` |
| Detached commit | `` |
## :arrow_forward: Inputs
The following inputs can be used to alter the Docker tag name determination:
| Input | Required | Default | Description |
|--------------------------------|----------|----------|---------------------------------------------------------------------------------|
| `latest_git_branch` | No | `master` | Optionally change the git branch, which determines the the Docker tag `latest`. |
| `latest_docker_tag_name` | No | `latest` | Optionally specify an alternative Docker tag name for `latest`. |
| `non_latest_docker_tag_prefix` | No | `` | Optionally add a prefix to all non-latest docker tags. |
| `non_latest_docker_tag_suffix` | No | `` | Optionally add a suffix to all non-latest docker tags. |
## :arrow_backward: Outputs
| Output | Description |
|--------------|-------------|
| `docker-tag` | The determined Docker tag name. |
## :computer: Usage
### Basic
The following Docker images will be pushed:
| Git state | Docker images |
|------------------------------------------------------|---------------------------|
| On branch `master` | `cytopia/php:latest` |
| On branch `release-0.1` | `cytopia/php:release-0.1` |
| On tag `v1.0.0` | `cytopia/php:v1.0.0` |
| On commit `1aaf12a472ac794d00b75b826db4d223c3ef2d96` | `cytopia/php:1aaf12a` |
```yaml
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
name: Deploy docker image
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Set Docker tag
id: tag
uses: cytopia/[email protected]
- name: build
run: |
docker build -t cytopia/php:${{ steps.tag.outputs.docker-tag }} .
- name: push
run: |
docker push cytopia/php:${{ steps.tag.outputs.docker-tag }}
```
### Matrix
The following Docker images will be pushed:
| Git state | Docker images |
|------------------------------------------------------|-----------------------------------------------------------------|
| On branch `master` | `cytopia/php:8.0`
`cytopia/php:8.1` |
| On branch `release-0.1` | `cytopia/php:8.0-release-0.1`
`cytopia/php:8.1-release-0.1` |
| On tag `v1.0.0` | `cytopia/php:8.0-v1.0.0`
`cytopia/php:8.1-v1.0.0` |
| On commit `1aaf12a472ac794d00b75b826db4d223c3ef2d96` | `cytopia/php:8.0-1aaf12a`
`cytopia/php:8.1-1aaf12a` |
```yaml
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
name: Deploy docker image
strategy:
fail-fast: false
matrix:
version:
- '8.0'
- '8.1'
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Set Docker tag
id: tag
uses: cytopia/[email protected]
with:
latest_git_branch: master
latest_docker_tag_name: ${{ matrix.version }}
non_latest_docker_tag_prefix: "${{ matrix.version }}-"
- name: build
run: |
docker build -t cytopia/php:${{ steps.tag.outputs.docker-tag }} .
- name: push
run: |
docker push cytopia/php:${{ steps.tag.outputs.docker-tag }}
```
## :exclamation: Keep up-to-date with GitHub Dependabot
Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot) has [native GitHub Actions support](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem), to enable it on your GitHub repo all you need to do is add the `.github/dependabot.yml` file:
```yml
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
```
## :octocat: [cytopia](https://github.com/cytopia) GitHub Actions
| Name | Description |
|----------------------------------|-------------|
| [docker-tag-action] | Determines Docker tags based on git branch, commit or git tag |
| [git-ref-matrix-action] | Create stringified JSON list of git refs to be used as a build matrix |
| [shell-command-retry-action] | Retries shell commands to avoid failing pipelines due to network issues |
| [upload-artifact-verify-action] | Upload artifact and verifies it by downloading it again |
| [upload-artifact-retry-action] | Retries `upload-artifact-verify-action` |
| [download-artifact-retry-action] | Download artifact with retry functionality |
[docker-tag-action]: https://github.com/cytopia/docker-tag-action
[git-ref-matrix-action]: https://github.com/cytopia/git-ref-matrix-action
[shell-command-retry-action]: https://github.com/cytopia/shell-command-retry-action
[upload-artifact-verify-action]: https://github.com/cytopia/upload-artifact-verify-action
[upload-artifact-retry-action]: https://github.com/cytopia/upload-artifact-retry-action
[download-artifact-retry-action]: https://github.com/cytopia/download-artifact-retry-action
## :page_facing_up: License
**[MIT License](LICENSE)**
Copyright (c) 2022 [cytopia](https://github.com/cytopia)