Deploying via GitHub Actions

This runbook outlines the standard procedure for manually triggering automated deployments for MyHeat applications using GitHub Actions.

Supported Repositories

The following projects currently have automated CI/CD deployment pipelines configured:

1. MyheatDigitalHub
2. Social TV
3. Ancestor Honor

Step-by-Step Deployment Guide

1. Navigate to the Repository
Go to the specific GitHub repository for the project you want to deploy.

2. Access GitHub Actions
Click on the Actions tab located along the top navigation bar of the repository.

3. Locate the Deployment Workflow
On the left-hand sidebar, you will see a list of available workflows. Look for the specific deployment workflow (this is usually named something like “Deploy” or “Deploy [Project Name]” — for example, “Deploy Ancestor Honor”). Click on it.

4. Trigger the Workflow
On the right side of the workflow page, click on the Run workflow dropdown button:

• Select the Branch: Choose the branch you want to deploy from (usually main, master, or an environment-specific branch like staging).

5. Start the Deployment
Click the green Run workflow button. The pipeline will be added to the queue and execute automatically.

Monitoring Progress & Viewing Logs

Once the workflow is triggered, a new run instance will appear in the list.

• Click on the new run to monitor its progress in real time.
• By clicking on the specific job (e.g., build or deploy), you can view a live terminal log of the deployment steps. This is the first place you should look to verify that files are being successfully copied to the server footprint.

Common Gotchas & Troubleshooting

When pipelines fail or behave unexpectedly, check these common issues:

• Missing “Run workflow” Button: If you cannot see the button, it is likely that you do not have sufficient Write/Admin permissions on the repository, or the workflow hasn’t been configured with the workflow_dispatch trigger.
• Workflow Not Appearing: The workflow YAML must exist in the default branch (usually main) for the manual trigger to appear on the Actions page. Make sure your .github/workflows/ files are pushed and merged to the default branch.
• Reviewing Failures (Red X): If a job fails, click into the failed step within the logs. Most deployment errors are related to missing GitHub Secrets, incorrect server credentials, or failing unit tests.
• Cache invalidation: Occasionally, GitHub Actions caches outdated Node modules, Nuget packages, or Composer dependencies. If a build inexplicably fails despite passing locally, clearing the repository’s Actions Cache or using a “re-run all jobs” command with clearing cache usually solves the problem.