Docker Workflow #26847

lpzhang-code · 2020-09-25T10:15:32Z

lpzhang-code
Sep 25, 2020

Hello everyone!

I am new to GitHub Actions. I am wondering if there are experienced people who can offer advice on setting up CI pipeline involving Docker container.

Ideally, I would like to do the following inside the same job: (1) build the Docker image, (2) run unit tests inside the container, (3) push the built image up to Docker Hub if the tests pass.

Answered by airtower-luna

Sep 25, 2020

lpzhang5:

I don’t know much about writing logic inside of YAML files, do you have any suggested resources?

There isn’t much. YAML itself is structured data. Github Actions defines some fields that can contain logic (mostly if: on steps or jobs). Most of the logic in your workflow will have to be in the steps.

lpzhang5:

where TAG_NAME is ‘staging’ if I push to develop branch and ‘prod’ if I push to master branch

You might have noticed this step in my example:

      - name: Generate container tag(s) and name
        run: |
          TAGS=$(python3 tag-from-ref.py ${{ github.ref }})
          echo "::set-env name=TAGS::${TAGS}"
          echo "::set-env name=CONTAINER_NAME::${{ gith…

View full answer

airtower-luna · 2020-09-25T11:31:22Z

airtower-luna
Sep 25, 2020

That’s definitely possible, I have an example of a similar setup here (pushing to GHCR instead): https://github.com/airtower-luna/hello-ghcr/blob/763f10f3fdc33e8bcef1d04508a3264cf1a06c16/.github/workflows/build.yaml

I just use the regular docker commands in the steps. Note that the docker logout at the end is run with if: always() to make sure the credentials are removed even if any intermediate step fails. There are also some pre-made actions like docker/login-action available if you prefer.

Your tests will probably look pretty different, for the simple test container I only do docker run and check if the output looks as expected. 😉

0 replies

lpzhang-code · 2020-09-25T12:25:23Z

lpzhang-code
Sep 25, 2020
Author

Thanks very much for this.

I don’t know much about writing logic inside of YAML files, do you have any suggested resources?

Specifically, I want to write logic where I have this step

- name: Build Docker Image run: docker build -t image_name:TAG_NAME .

where TAG_NAME is ‘staging’ if I push to develop branch and ‘prod’ if I push to master branch

0 replies

airtower-luna · 2020-09-25T14:12:33Z

airtower-luna
Sep 25, 2020

lpzhang5:

I don’t know much about writing logic inside of YAML files, do you have any suggested resources?

There isn’t much. YAML itself is structured data. Github Actions defines some fields that can contain logic (mostly if: on steps or jobs). Most of the logic in your workflow will have to be in the steps.

lpzhang5:

where TAG_NAME is ‘staging’ if I push to develop branch and ‘prod’ if I push to master branch

You might have noticed this step in my example:

      - name: Generate container tag(s) and name
        run: |
          TAGS=$(python3 tag-from-ref.py ${{ github.ref }})
          echo "::set-env name=TAGS::${TAGS}"
          echo "::set-env name=CONTAINER_NAME::${{ github.repository_owner }}/hello-ghcr-meow"

The tag-from-ref.py processes ${{ github.ref }} to decide which tag(s) to use, and the result is then stored in an environment variable.

Whether it makes sense to create a script file like I did or put the script directly into a step is part a matter of taste and also depends on how complex your selection is. You could just do something like this for what you described:

      - name: Generate container tag
        run: |
          if [ "${{ github.ref }}" = "refs/heads/develop" ]; then
              echo "::set-env name=TAG_NAME::staging"
          elif [ "${{ github.ref }}" = "refs/heads/master" ]; then
              echo "::set-env name=TAG_NAME::prod"
          else
              # whatever you want to do for other branches/tags
          fi

0 replies

lpzhang-code · 2020-09-27T08:14:39Z

lpzhang-code
Sep 27, 2020
Author

Thanks for your help.

I have adapted the logic you have written and workflow is working as intended.

I have also learned quite a bit about the general process, previously I was very unfamiliar.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

Docker Workflow #26847

{{title}}

Replies: 4 comments

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

GitHub Community

Docker Workflow #26847

lpzhang-code Sep 25, 2020

Replies: 4 comments

airtower-luna Sep 25, 2020

lpzhang-code Sep 25, 2020 Author

airtower-luna Sep 25, 2020

lpzhang-code Sep 27, 2020 Author

lpzhang-code
Sep 25, 2020

airtower-luna
Sep 25, 2020

lpzhang-code
Sep 25, 2020
Author

airtower-luna
Sep 25, 2020

lpzhang-code
Sep 27, 2020
Author