How It Works — Step‐by‐Step - CynicDog/agile-github-starter GitHub Wiki
-
-
Start by creating a new GitHub issue
-
This will automatically create a new branch:
-
feature/issue-<number>
— for regular work -
hotfix/issue-<number>
— if the issue is labeledhotfix
-
-
-
-
Checkout the branch locally:
git checkout feature/issue-42
-
Make your changes and push commits as usual.
-
-
- Open a PR from your feature branch to the
main
branch
- Open a PR from your feature branch to the
-
- When you open a PR to
main
, the bot will post a checklist comment:
- Each comment triggers the corresponding GitHub Actions workflow.
- Monitor the CI/CD workflow runs at GitHub Actions tab for the repository.
- When you open a PR to
-
-
Merge your PR to:
-
development
— after passing build & deploy checks -
stage
— for pre-prod validation -
main
— for final production release
-
-
-
-
For feature branches:
- Use the build artifact from the
stage
branch - Trigger
deploy for production
via comment - Then merge the PR to
main
- Use the build artifact from the
-
For hotfix branches:
- Merging the PR to
main
will automatically deploy - The hotfix branch will be deleted, which triggers the deployment
- Merging the PR to
-
-
- The original GitHub issue will automatically close once its branch is deleted.