GitHub Workflows

This directory contains GitHub Actions workflows for the SynergyBootstrap project.

Available Workflows

CI (Continuous Integration)

• File: workflows/ci.yml
• Trigger: Push to main/master/clean-branch or PR to these branches
• Purpose: Run tests, linting, and validate project structure
• Features:
  • Installs dependencies
  • Runs linting (if available)
  • Validates code structure
  • Runs tests (if available)
  • Checks shell scripts

Documentation

• File: workflows/docs.yml
• Trigger: Push to main/master/clean-branch with changes to docs/
• Purpose: Build and organize documentation
• Features:
  • Copies documentation files
  • Creates an index of all documentation
  • Adds links to special documents

Release

• File: workflows/release.yml
• Trigger: Pushing a tag that matches the pattern v*.*.*
• Purpose: Create a release package and GitHub release
• Features:
  • Creates a full package (all files)
  • Creates a minimal package (only essential files)
  • Generates release notes
  • Adds installation instructions

Branch Management

• File: workflows/branch-management.yml
• Trigger: Branch creation, PR closure, or manual dispatch
• Purpose: Enforce branch naming conventions and clean up
• Features:
  • Validates that branches follow the pattern <type>/<module-name>/<description>
  • Identifies branches that have been merged and can be deleted
  • Can be manually triggered with the "validate" or "cleanup" action

Using These Workflows

These workflows run automatically on the appropriate triggers, but you can also run the branch management workflow manually from the Actions tab in GitHub.

For releases, you need to create and push a tag:

git tag v1.0.0
git push origin v1.0.0