README.md

Reusable Workflows for Developing GitHub Actions

The repository contains reusable workflows and provides a collection of workflow templates that facilitate the development of GitHub actions across several repositories.

Background

These workflows are designed to help streamline common development tasks, such as building and testing code, deploying applications. By using reusable workflows, developers can save time and effort by avoiding the need to recreate the same workflows across multiple repositories. Additionally, the repository includes documentation and best practices for creating and sharing reusable workflows.

Available workflows

Build & push docker image

This workflow automates the building, tagging, and pushing of Docker images to GitHub's Container Registry.

Usage

docker-build-push:
  uses: AplinkosMinisterija/reusable-workflows/.github/workflows/docker-build-push.yml@main
  with:
    docker-image: ghcr.io/AplinkosMinisterija/example-monorepo
    docker-context: backend
    environment: production
    runs-on: ubuntu-latest
    docker-platforms: 'linux/amd64,linux/arm64'
    latest-tag: true
    git-ref: 1084a50
    push: true

For additional information see docker-build-push.yml

Using workflows in real-life

Continuous deployment

To ensure continuous deployment in a real-world scenario, I would like to create workflows that:

• Utilize Trunk-based development as a version control management practice.
• Have three environments:
  • Development, used for testing non-production ready features.
  • Staging, which always points to the main branch.
  • Production which deploys after publishing new release in GitHub and uses Semantic Versioning.
• Include caching to speed up the process.
• Be able to push to GitHub Container registry with meaningful image tags.
• Build a multi-arch image that supports AMD64 and ARM64 architectures.

Examples

deploy-development.yml

name: Deploy to Development

on:
  workflow_dispatch:
    inputs:
      git-ref:
        description: Git Ref (Optional)
        required: false

concurrency: deploy-to-development

jobs:
  docker-build-push:
    name: Build & push docker image
    uses: AplinkosMinisterija/reusable-workflows/.github/workflows/docker-build-push.yml@main
    with:
      docker-image: ghcr.io/aplinkosministerija/example-monorepo
      docker-context: backend
      environment: development
      runs-on: ubuntu-latest
      git-ref: ${{ github.event.inputs.git-ref }}
      push: true

  deploy:
    name: My Deployment
    needs: [ docker-build-push ]
    runs-on: ubuntu-latest

    steps:
      - run: echo "TODO"

deploy-staging.yml

name: Deploy to Staging

on:
  push:
    branches: [ main ]

concurrency: deploy-to-staging

jobs:
  docker-build-push:
    name: Build & push docker image
    uses: AplinkosMinisterija/reusable-workflows/.github/workflows/docker-build-push.yml@main
    with:
      docker-image: ghcr.io/aplinkosministerija/example-monorepo
      docker-context: backend
      environment: staging
      runs-on: ubuntu-latest
      push: true

  deploy:
    name: My Deployment
    needs: [ docker-build-push ]
    runs-on: ubuntu-latest

    steps:
      - run: echo "TODO"

deploy-production.yml

name: Deploy to Production

on:
  push:
    tags:
      - 'v[0-9]+.[0-9]+.[0-9]+'

concurrency: deploy-to-production

jobs:
  docker-build-push:
    name: Build & push docker image
    uses: AplinkosMinisterija/reusable-workflows/.github/workflows/docker-build-push.yml@main
    with:
      docker-image: ghcr.io/aplinkosministerija/example-monorepo
      docker-context: backend
      environment: production
      runs-on: ubuntu-latest
      latest-tag: true
      push: true

  deploy:
    name: My Deployment
    needs: [ docker-build-push ]
    runs-on: ubuntu-latest

    steps:
      - run: echo "TODO"

Inspiration

The inspiration behind this project comes from actions/reusable-workflows.

License

The scripts and documentation in this project are released under the MIT License

Contributing

Contributions are welcome! See Contributor's Guide