dockerhub-publish.yml

#
#  Copyright (c) 2024, The OpenThread Authors.
#  All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are met:
#  1. Redistributions of source code must retain the above copyright
#     notice, this list of conditions and the following disclaimer.
#  2. Redistributions in binary form must reproduce the above copyright
#     notice, this list of conditions and the following disclaimer in the
#     documentation and/or other materials provided with the distribution.
#  3. Neither the name of the copyright holder nor the
#     names of its contributors may be used to endorse or promote products
#     derived from this software without specific prior written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
#  POSSIBILITY OF SUCH DAMAGE.
#

name: Download docker image artifact and publish to DockerHub

on:
  workflow_call:
    inputs:
      artifact_name:
        description: 'The name of the artifact containing the docker image'
        type: string
        required: true
      image_name:
        description: 'The name of the docker image'
        type: string
        required: true
      new_image_name:
        description: 'The new name of the docker image'
        type: string
        required: false
    secrets:
      DOCKERHUB_USERNAME:
        description: 'DockerHub username'
      DOCKERHUB_PERSONAL_ACCESS_TOKEN:
        description: 'DockerHub personal access token'

jobs:
  publish:
    name: Tag `latest` and publish to DockerHub
    runs-on: ubuntu-22.04
    steps:
      - name: Login to DockerHub
        uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_PERSONAL_ACCESS_TOKEN }}

      - name: 'Download artifact'
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
        with:
          name: ${{ inputs.artifact_name }}

      - name: Load Docker image
        run: docker load -i ${INPUTS_IMAGE_NAME}.tar
        env:
          INPUTS_IMAGE_NAME: ${{ inputs.image_name }}

      - name: Tag Docker image
        if: inputs.new_image_name
        run: docker tag ${INPUTS_IMAGE_NAME} ${INPUTS_NEW_IMAGE_NAME}
        env:
          INPUTS_IMAGE_NAME: ${{ inputs.image_name }}
          INPUTS_NEW_IMAGE_NAME: ${{ inputs.new_image_name }}

      - name: Push Docker image
        run: docker push ${INPUTS_NEW_IMAGE_NAME:-$INPUTS_IMAGE_NAME}
        env:
          INPUTS_IMAGE_NAME: ${{ inputs.image_name }}
          INPUTS_NEW_IMAGE_NAME: ${{ inputs.new_image_name }}