examples-github-action

What is the purpose of this repository?

This repository is just my personal playground for learning and experimenting with GitHub Actions.

The content here might actually be helpful to other developers facing similar issues.

However, please keep in mind that this code is based solely on my own perspective and probably has lots of inaccurate or questionable parts!

Examples

• Chapter 1 - Basics of GitHub Actions

  • Hello World

• Chapter 2 - Hands-on CI/CD implementation

  • Implement CI using pull request triggers
  • Implement CD functionality using a merge-based approach

• Chapter 3 - Features required for real-world deployments

  • Available values ​​(context) within the workflow
  • Saving job outputs (artifacts) and passing them on to the next job
  • Job and step execution control (Control Flow)
  • Accelerating CI processes through cache utilization
  • Workflow triggers
  • About GitHub Actions permissions

• Chapter 4 - Challenges and solutions of using GitHub Actions in large-scale development

  • Using containers via jobs
  • Application of job execution using matrix strategy
    • Use case 1: Test Splitting
    • Use case 2: Dynamically building jobs
  • Control the timing of the cache

• Chapter 5 - Workflow design for large-scale development

  • A workflow that takes maintainability into consideration
    • Reuseable workflow (Caller)
    • Reuseable workflow (Playwright)
    • Custom action (setup-playwright)
  • Execute at various times
    • When a pull request is opened
    • When the pull request is updated
    • When the pull request is closed
  • Workflow optimization
    • Skip the job based on whether there are any changes
    • Rerun only failed tests

• Articles

  • Automatically detect changes and execute in parallel for each project
  • Build and push multiplatform Docker images to GitHub Container Registry
  • OIDC authentication (Workload Identity federation)

• Appendix

  • 11 Best Practices for GitHub Actions

References

• Software Design July 2024 - Gijutsu-Hyoron Co., Ltd
  • Special Feature 1 GitHub Actions 実践講座