How It Works — Step‐by‐Step - CynicDog/agile-github-starter GitHub Wiki

  1. Create an Issue

    • Start by creating a new GitHub issue image

    • This will automatically create a new branch:

      • feature/issue-<number> — for regular work
      • hotfix/issue-<number> — if the issue is labeled hotfix
      image
  2. Commit Code to the Branch

    • Checkout the branch locally:

      git checkout feature/issue-42
    • Make your changes and push commits as usual.

  3. Open a Pull Request

    • Open a PR from your feature branch to the main branch
    image
  4. CI/CD Bot Comment

    • When you open a PR to main, the bot will post a checklist comment:
    image
    • Each comment triggers the corresponding GitHub Actions workflow.
    image
    • Monitor the CI/CD workflow runs at GitHub Actions tab for the repository.
    image
  5. Merge Sequence

    • Merge your PR to:

      • development — after passing build & deploy checks
      • stage — for pre-prod validation
      • main — for final production release
  6. Production Deployment

    • For feature branches:

      • Use the build artifact from the stage branch
      • Trigger deploy for production via comment
      • Then merge the PR to main
    • For hotfix branches:

      • Merging the PR to main will automatically deploy
      • The hotfix branch will be deleted, which triggers the deployment
  7. Cleanup

    • The original GitHub issue will automatically close once its branch is deleted.
⚠️ **GitHub.com Fallback** ⚠️