Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up initial CI/CD #3

Merged
merged 2 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .ci.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# This file is used to allow CI to start the compose services. It will typcially
# not need to be modified.

MYSQL_DATABASE=mysql_database
MYSQL_USER=mysql_user
MYSQL_PASSWORD=mysql_password
MYSQL_PORT=3306
MYSQL_ROOT_PASSWORD=test123!
MYSQL_HOST=db

ALLOWED_HOSTS='127.0.0.1,localhost'
CORS_ORIGIN_WHITELIST='http://127.0.0.1:3000,http://localhost:3000'
CSRF_TRUSTED_ORIGINS='http://127.0.0.1:8000,http://localhost:8000'

SECRET_KEY='secret_key'
DEBUG='True'

# Add the following to your local .env file. They will be used in the CI process
# and you can largely forget about them, but including them in your .env file
# will act like a safe default and help suppress warnings.
REGISTRY=""
TAG=""
60 changes: 60 additions & 0 deletions .github/workflows/build-and-deploy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 'Build and deploy application containers'
on:
push:
jobs:
build-tag-push-deploy:
runs-on: ubuntu-latest
# CI/CD will run on these branches
if: >
github.ref == 'refs/heads/main' ||
github.ref == 'refs/heads/staging' ||
github.ref == 'refs/heads/development'

strategy:
matrix:
# Specify the docker-compose services to build images from. These should match the service
# names in the docker-compose.yml file.
service: [sdwebapp, sdnginx]
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Login to GitHub container registry
uses: docker/login-action@v1
with:
registry: ghcr.io
username: cmu-delphi-deploy-machine
password: ${{ secrets.CMU_DELPHI_DEPLOY_MACHINE_PAT }}
- name: Create container image tags
id: image-tag
run: |
baseRef="${GITHUB_REF#*/}"
baseRef="${baseRef#*/}"
case "${baseRef}" in
main)
image_tag="latest"
;;
*)
image_tag="${baseRef//\//_}" # replace `/` with `_` in branch name
;;
esac
echo "IMAGE_TAG=${image_tag}" >> $GITHUB_OUTPUT
- name: Copy env file
run: |
cp ./.ci.env ./.env
- name: Set up docker-compose
uses: ndeloof/install-compose-action@v0.0.1
- name: docker-compose build --push
run: |
docker-compose build --push ${{ matrix.service }}
env:
TAG: ":${{ steps.image-tag.outputs.IMAGE_TAG }}"
REGISTRY: "ghcr.io/${{ github.repository_owner }}/"
- name: docker-compose down
run: |
docker-compose down
- name: Trigger smee.io webhook to pull new container images
run: |
curl -H "Authorization: Bearer ${{ secrets.DELPHI_DEPLOY_WEBHOOK_TOKEN }}" \
-X POST ${{ secrets.DELPHI_DEPLOY_WEBHOOK_URL }} \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "repository=ghcr.io/${{ github.repository }}-${{ matrix.service }}&tag=${{ steps.image-tag.outputs.IMAGE_TAG }}"
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.env
.secrets
/.vscode/
/src/media/
/src/staticfiles/
*log
*.mo
*.pyc
htmlcov/
.coverage
.coverage.*
coverage.xml
*.cover
celerybeat-schedule.*
12 changes: 6 additions & 6 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
services:
db:
image: mysql:latest
container_name: signal_documentation-db
container_name: signal-discovery-db
restart: always
env_file:
- ./.env
Expand All @@ -16,15 +16,15 @@ services:
- "3306:3306"

# Production service - "service", "image", and "container_name" should all contain the same
# reference, based on the name of the service.
# reference based on the name of the service.
sdwebapp:
image: ${REGISTRY}signal_documentation-sdwebapp${TAG}
image: ${REGISTRY}signal-discovery-sdwebapp${TAG}
build:
context: .

env_file:
- ./.env
container_name: signal_documentation-sdwebapp
container_name: signal-discovery-sdwebapp
restart: on-failure
command:
sh -c "python3 /usr/src/signal_documentation/src/manage.py migrate --noinput &&
Expand All @@ -41,11 +41,11 @@ services:
# Production service - "service", "image", and "container_name" should all contain the same
# reference, based on the name of the service.
sdnginx:
image: ${REGISTRY}signal_documentation-sdnginx${TAG}
image: ${REGISTRY}signal-discovery-sdnginx${TAG}
build: ./nginx
env_file:
- ./.env
container_name: signal_documentation-sdnginx
container_name: signal-discovery-sdnginx
restart: on-failure
volumes:
- ./src/staticfiles:/staticfiles
Expand Down
Loading