This repository is used to learn GitHub Actions. This repository app uses FastAPI which is a Python web framework and then dockerize it and push it to Docker Registry. This GitHub Action is used as CI to build and test FastAPI app. This GitHub Action is used as CI to build docker image in dev branch for non-production environment and push it to Docker Registry after pull request is merged to dev branch. This GitHub Action is used as CI to build docker image in main branch for production environment and push it to Docker Registry after publish a release.
The CD flow uses Argo CD from this repository
-
Create repository secrets named DOCKERHUB_USERNAME and DOCKERHUB_TOKEN
-
Create dev branch from main branch for testing
-
Create feature branch from main branch for development
-
Once development is done, merge feature branch to dev branch using pull request to test it in non-production environment. An Action will run in this pull request.
-
Merged it and an Action will run to build Docker image for non-production environment
-
If it's running properly in non-production environment, adjust the code to suit the production environment, merge feature branch to dev branch using pull request and merge feature branch to main branch using pull request. Another Action will run in this pull request
-
Merged those 2 pull request and an Action will run to build Docker image for non-production environment and push it to Docker Registry
-
Create a tag in main branch. Example:
git checkout main git tag -a v0.2.0 -m "Release version 0.2.0" git push origin v0.2.0 -
Publish a release using the tag that has been made before and Action will run to build Docker image for production environment and push it to Docker Registry
-
Create Python virtual environment
python3 -m venv env -
Activate virtual environment
source env/bin/activateTo deactivae virtual environment
deactivate -
Install requirements
pip3 install -r requirements.txt
-
Run FastAPI app
uvicorn src.main:app --reloadOr
pyton3 src/main.py -
Build Docker image
docker build -t fastapi-cicd:1.0 . -
Create and run container from Docker image
docker run -d --name fastapi -p 80:8000 fastapi-cicd:1.0If container already exist, run container with
docker start <container_name> -
Acces the FastAPI container in 127.0.0.1:80