QUICKSTART.md

🚀 Quick Start Guide

Get started with GitHub Shared Workflows in 5 minutes!

Installation

No installation needed! Just reference the workflows in your repository.

Basic Usage

1. Terraform Checks

name: Terraform Validation
on: [pull_request]

jobs:
  validate:
    uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@v2
    with:
      working_directory: './terraform'
      provider: 'aws'
    secrets:
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

2. Docker Build & Push

name: Build and Push Docker Image
on: [push]

jobs:
  docker:
    uses: clouddrove/github-shared-workflows/.github/workflows/docker-build-push.yml@v2
    with:
      provider: 'aws'
      ECR_REPOSITORY: 'my-app'
      IMAGE_TAG: ${{ github.sha }}
    secrets:
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

3. PR Validation

name: PR Checks
on: [pull_request]

jobs:
  validate:
    uses: clouddrove/github-shared-workflows/.github/workflows/pr-checks.yml@v2

Common Patterns

Using Specific Versions

Instead of @master, use version tags for stability:

uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@v2

Environment-Specific Workflows

jobs:
  deploy:
    uses: clouddrove/github-shared-workflows/.github/workflows/tf-workflow.yml@v2
    with:
      target_environment: 'production'

Next Steps

• Browse all available workflows
• Check detailed documentation for each workflow
• See examples for your specific use case

Need Help?

• 📖 Read the full documentation
• 💬 Open a discussion
• 🐛 Report issues