Custom GitHub Actions

This document provides an overview of the custom GitHub Actions available in the Hatchgrid project.

Docker Composition Actions

The Docker composition actions are specialized GitHub Actions that handle building and pushing Docker images for different application types. For detailed information, see:

Available Docker Actions

Backend Docker Action: .github/actions/docker/backend/action.yml
Frontend Web App Action: .github/actions/docker/frontend-web/action.yml
Frontend Landing Page Action: .github/actions/docker/frontend-landing/action.yml
Security Scanning Action: .github/actions/docker/security-scan/action.yml

Setup Actions

The setup actions are used to configure the build environment for different technology stacks.

Java Setup Action

Location: .github/actions/setup/java/action.yml

Purpose: Sets up Java and Gradle with caching for backend builds.

Usage Example:

- name: Setup Java
  uses: ./.github/actions/setup/java
  with:
    java-version: '21'

Node.js Setup Action

Location: .github/actions/setup/node/action.yml

Purpose: Sets up Node.js and pnpm with caching for frontend builds.

Usage Example:

- name: Setup Node.js and pnpm
  uses: ./.github/actions/setup/node
  with:
    node-version: '22'

Best Practices

Use Specialized Actions: Choose the appropriate specialized action for your application type
Leverage Caching: All actions include caching mechanisms to speed up builds
Security Scanning: Always include security scanning in your workflows
Error Handling: Check the action outputs and logs for detailed error information
Documentation: Keep the documentation up-to-date when modifying actions