github-actions

GitHub Actions Workflow Rules

Overview

Rules for modifying GitHub Actions workflow files (.github/workflows/*.yml) in go-crypto-wallet.

Runner Configuration

Required Runner

Always use ubuntu-slim as the runner unless there is a specific reason to use another image.

# Good
runs-on: ubuntu-slim

# Avoid (unless specifically needed)
runs-on: ubuntu-latest
runs-on: ubuntu-24.04

Why ubuntu-slim?

• Faster startup time (smaller image)
• Lower resource consumption
• Contains essential tools for most CI tasks
• Cost-effective for GitHub Actions minutes

Reference: GitHub Actions Runner Images

Available Runners

Image	YAML Label	Use Case
Ubuntu Slim	ubuntu-slim	Default choice - most CI tasks
Ubuntu 24.04	ubuntu-latest or ubuntu-24.04	When additional tools are required
Ubuntu 22.04	ubuntu-22.04	Legacy compatibility

Performance Best Practices

Avoid Duplication

1. Reusable Workflows: Extract common patterns into reusable workflows
2. Composite Actions: Create composite actions for repeated steps
3. Matrix Strategy: Use matrix for parallel execution instead of duplicate jobs

# Good: Matrix strategy for parallel execution
strategy:
  matrix:
    go-version: ['1.22', '1.23']

# Avoid: Duplicate jobs for each version
jobs:
  test-go-122:
    ...
  test-go-123:
    ...

Caching

Always use caching for dependencies:

- uses: actions/cache@v4
  with:
    path: |
      ~/.cache/go-build
      ~/go/pkg/mod
    key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}

Conditional Execution

Use path filters to avoid unnecessary runs:

on:
  push:
    paths:
      - '**.go'
      - 'go.mod'
      - 'go.sum'

Branch Configuration

Default Branch

This repository uses main as the default branch. Always use main (not master):

# Good
on:
  push:
    branches:
      - main

# Wrong
on:
  push:
    branches:
      - master