Continuous Integration - GitHub - Publish

---

Overview

Opinionated GitHub Actions and workflows for streamlined release, deployment, and publishing.

Actions

ArgoCD

Actions dedicated to ArgoCD workflows.

- Get manifest files

Checks

Actions for validating the result of a deploy.

- URL - Lighthouse

- URL - Ping

Clean deploy

Actions for cleaning deployments on various platforms.

- Repository dispatch

Deploy

Actions for deploying to various platforms.

- Argocd manifest files

- Get environment

- GitHub Pages

- Helm repository dispatch

- Jampack

- Jekyll

- Report

Deployment

Actions for managing deployments.

- Create

- Delete

- Get finished

- Read

- Update

Release

Actions for managing releases.

- Create

Workflow

Actions for managing workflows.

- Get workflow failure

Reusable Workflows

Cleaning deploy

- Clean deploy argocd app of apps

- Clean deploy

Performs deploy

- Deploy argocd app of apps

- Deploy chart

- Deploy start

- Deploy checks

- Deploy finish

- Finish deploy argocd app of apps

Releases

Reusable workflows for managing release process.

- Prepare release

- Release actions

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

Action Structure Pattern

All actions follow this consistent structure:

actions/{category}/{action-name}/
├── action.yml          # Action definition with inputs/outputs
├── README.md          # Usage documentation
└── *.js              # Optional Node.js scripts (e.g., prepare-site.js)

Development Standards

Action Definition Standards

1. Consistent branding: All actions use author: hoverkraft, icon: <specific-icon>, color: blue
2. Composite actions: Use using: "composite" with GitHub Script for complex logic
3. Pinned dependencies: Always pin action versions with SHA (e.g., @ed597411d8f924073f98dfc5c65a23a2325f34cd)
4. Input validation: Validate inputs early in GitHub Script steps

JavaScript Patterns

• Class-based architecture: Use classes like AssetManager for complex functionality
• Path utilities: Extensive use of Node.js path module for cross-platform compatibility
• Regular expression patterns: Define constants for reusable patterns (MARKDOWN_IMAGE_REGEX, HTML_IMAGE_REGEX)
• Caching: Implement Map-based caching for expensive operations

Development Workflow

Linting & Testing

make lint        # Run Super Linter (dockerized)
make lint-fix    # Auto-fix issues where possible

# Use GitHub Actions locally with `act`
gh act -W .github/workflows/workflow-file-to-test.yml

File Conventions

• Dockerfile: Uses Super Linter slim image for consistent code quality
• Tests: Located in tests/ with expected vs actual file comparisons
• Workflows: Private workflows prefixed with __ (e.g., __main-ci.yml)

Action Development Conventions

Always follow these patterns when creating/modifying actions:

1. Pinned Dependencies: Use exact SHA commits for all action dependencies:

   uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0

2. Consistent Branding: Every action.yml must include:

   author: hoverkraft
   branding:
     icon: <specific-icon>
     color: blue

3. Input Validation: Always validate inputs early in GitHub Script steps:

   const urlInput = ${{ toJson(inputs.url ) }};
   if (!urlInput) {
     return core.setFailed("URL input is required.");
   }

JavaScript Development Patterns

For Node.js scripts (like prepare-site.js):

• Use class-based architecture for complex functionality
• Define regular expression patterns as constants (MARKDOWN_IMAGE_REGEX, HTML_IMAGE_REGEX)
• Implement Map-based caching for expensive operations
• Always use Node.js path module for cross-platform compatibility

File Structure Understanding

actions/{category}/{action-name}/     # Modular action organization
├── action.yml                        # Action definition with inputs/outputs
├── README.md                         # Usage documentation
└── *.js                             # Optional Node.js scripts

.github/workflows/                    # Reusable workflows
├── deploy-*.yml                      # Deployment orchestration
├── clean-deploy-*.yml               # Cleanup workflows
└── __*.yml                          # Private/internal workflows

tests/                               # Expected vs actual comparisons
└── argocd-app-of-apps/             # Template testing structure

Author

🏢 Hoverkraft [email protected]

• Site: https://hoverkraft.cloud
• GitHub: @hoverkraft-tech

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2025 hoverkraft-tech

For more details, see the license.