| 1 | name: Create and publish a Docker image |
| 2 | |
| 3 | # Configures this workflow to run every time a change is pushed to the branch called `release`. |
| 4 | on: |
| 5 | push: |
| 6 | branches: ['main'] |
| 7 | |
| 8 | # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds. |
| 9 | env: |
| 10 | REGISTRY: ghcr.io |
| 11 | IMAGE_NAME: ${{ github.repository }} |
| 12 | |
| 13 | # There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu. |
| 14 | jobs: |
| 15 | build-and-push-image: |
| 16 | runs-on: ubuntu-latest |
| 17 | # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job. |
| 18 | permissions: |
| 19 | contents: read |
| 20 | packages: write |
| 21 | # |
| 22 | steps: |
| 23 | - name: Checkout repository |
| 24 | uses: actions/checkout@v4 |
| 25 | - name: Free Up GitHub Actions Ubuntu Runner Disk Space 🔧 |
| 26 | uses: jlumbroso/free-disk-space@main |
| 27 | with: |
| 28 | # This might remove tools that are actually needed, if set to "true" but frees about 6 GB |
| 29 | tool-cache: false |
| 30 | |
| 31 | # All of these default to true, but feel free to set to "false" if necessary for your workflow |
| 32 | android: true |
| 33 | dotnet: true |
| 34 | haskell: true |
| 35 | large-packages: false |
| 36 | swap-storage: false |
| 37 | docker-images: false |
| 38 | # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here. |
| 39 | - name: Log in to the Container registry |
| 40 | uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 |
| 41 | with: |
| 42 | registry: ${{ env.REGISTRY }} |
| 43 | username: ${{ github.actor }} |
| 44 | password: ${{ secrets.GITHUB_TOKEN }} |
| 45 | # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels. |
| 46 | - name: Extract metadata (tags, labels) for Docker |
| 47 | id: meta |
| 48 | uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 |
| 49 | with: |
| 50 | images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} |
| 51 | # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages. |
| 52 | # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository. |
| 53 | # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step. |
| 54 | - name: Build and push Docker image |
| 55 | uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4 |
| 56 | with: |
| 57 | context: . |
| 58 | push: true |
| 59 | tags: ${{ steps.meta.outputs.tags }} |
| 60 | labels: ${{ steps.meta.outputs.labels }} |
| 61 |