Skip to content

Commit

Permalink
Merge pull request #2 from ErhanCitil/feature/creating-model-structure
Browse files Browse the repository at this point in the history
[#1] Creating a model structure
  • Loading branch information
ErhanCitil committed Oct 4, 2023
2 parents 09dcfcb + 8f18ebc commit e5edcdf
Show file tree
Hide file tree
Showing 27 changed files with 9,570 additions and 270 deletions.
180 changes: 4 additions & 176 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
name: Run build pipeline

# Run this workflow every time a new commit pushed to your repository
on:
push:
branches:
Expand Down Expand Up @@ -28,7 +27,6 @@ jobs:
POSTGRES_HOST_AUTH_METHOD: trust
ports:
- 5432:5432
# Needed because the postgres container does not provide a healthcheck
options:
--health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
redis:
Expand All @@ -40,19 +38,10 @@ jobs:
- name: Set up backend environment
uses: maykinmedia/setup-django-backend@v1
with:
python-version: '3.10.9'
python-version: '3.9'
optimize-postgres: 'yes'
pg-service: 'postgres'
setup-node: 'yes'
# apt-packages: 'gettext postgresql-client' # the default
# npm-ci-flags: '--legacy-peer-deps' -> preferably use a .npmrc file

# Any additional services -> create docker-compose setups in a (new) `docker`
# subdirectory.
# - name: Start CI docker services
# run: |
# docker-compose -f docker-compose.ci.yml up -d
# working-directory: docker

- name: Run tests
run: |
Expand All @@ -67,64 +56,23 @@ jobs:
- name: Publish coverage report
uses: codecov/codecov-action@v3

# API projects: implement the necessary scripts for this. You can take a look
# at open-forms for inspiration, using drf-spectacular.
# - name: Generate OAS
# run: ./bin/generate_oas.sh openapi.yaml

# - name: Store generated OAS
# uses: actions/upload-artifact@v3
# with:
# name: bobvance-oas
# path: openapi.yaml
# retention-days: 1

# docs:
# name: Build and check documentation
# runs-on: ubuntu-latest

# steps:
# - uses: actions/checkout@v3
# - uses: actions/setup-python@v4
# with:
# python-version: '3.9'

# # - name: Install OS dependencies
# # run: |
# # sudo apt-get update
# # sudo apt-get install libxml2-dev libxmlsec1-dev libxmlsec1-openssl

# - name: Install dependencies
# run: |
# pip install -r requirements/ci.txt

# - name: Build and test docs
# working-directory: docs
# run: pytest check_sphinx.py -v --tb=auto

docker_build:
name: Build Docker image
runs-on: ubuntu-latest
needs: tests
steps:
- uses: actions/checkout@v3

- name: Set tag
id: vars
run: |
# Strip git ref prefix from version
VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
# Strip "v" prefix from tag name (if present at all)
[[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
# Use Docker `latest` tag convention
[ "$VERSION" == "main" ] && VERSION=latest
# PRs result in version 'merge' -> transform that into 'latest'
[ "$VERSION" == "merge" ] && VERSION=latest
echo "tag=${VERSION}" >> $GITHUB_OUTPUT
echo "git_hash=${GITHUB_SHA}" >> $GITHUB_OUTPUT
- name: Build the production Docker image
run: |
Expand All @@ -143,127 +91,12 @@ jobs:
path: image.tar
retention-days: 1

# API projects: implement the necessary scripts for this. You can take a look
# at open-forms for inspiration, using drf-spectacular.
# oas-up-to-date:
# needs: tests
# name: Check for unexepected OAS changes
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v3
# - name: Download generated OAS
# uses: actions/download-artifact@v3
# with:
# name: bobvance-oas
# - name: Check for OAS changes
# run: |
# diff openapi.yaml src/openapi.yaml
# - name: Write failure markdown
# if: ${{ failure() }}
# run: |
# echo 'Run the following command locally and commit the changes' >> $GITHUB_STEP_SUMMARY
# echo '' >> $GITHUB_STEP_SUMMARY
# echo '```bash' >> $GITHUB_STEP_SUMMARY
# echo './bin/generate_oas.sh' >> $GITHUB_STEP_SUMMARY
# echo '```' >> $GITHUB_STEP_SUMMARY
#
# oas-lint:
# needs: oas-up-to-date
# name: Validate OAS
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v3
# - name: Download generated OAS
# uses: actions/download-artifact@v3
# with:
# name: bobvance-oas
# - name: Use Node.js
# uses: actions/setup-node@v3
# with:
# node-version-file: '.nvmrc'
# - name: Install spectral
# run: npm install -g @stoplight/spectral@5.9.2
# - name: Run OAS linter
# run: spectral lint ./openapi.yaml

# oas-postman:
# needs: oas-up-to-date
# name: Generate Postman collection from OAS
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v3
# - name: Download generated OAS
# uses: actions/download-artifact@v3
# with:
# name: bobvance-oas
# - name: Use Node.js
# uses: actions/setup-node@v3
# with:
# node-version-file: '.nvmrc'
# - name: Install dependencies
# run: npm install -g openapi-to-postmanv2
# - name: Create tests folder
# run: mkdir -p ./tests/postman
# - name: Generate Postman collection
# run: openapi2postmanv2 -s ./openapi.yaml -o ./tests/postman/collection.json --pretty

# oas-generate-sdks:
# needs: oas-up-to-date
# name: Generate SDKs from OAS
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v3
# - name: Download generated OAS
# uses: actions/download-artifact@v3
# with:
# name: bobvance-oas
# - name: Use Node.js
# uses: actions/setup-node@v3
# with:
# node-version-file: '.nvmrc'
# - name: Install dependencies
# run: npm install -g @openapitools/openapi-generator-cli@2.4.2
# - name: Validate schema
# run: openapi-generator-cli validate -i ./openapi.yaml
# - name: Generate Java client
# run:
# openapi-generator-cli generate -i ./openapi.yaml
# --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false \ -o
# ./sdks/java -g java
# --additional-properties=dateLibrary=java8,java8=true,optionalProjectFile=false,optionalAssemblyInfo=false
# - name: Generate .NET Core client
# run:
# openapi-generator-cli generate -i ./openapi.yaml
# --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false \ -o
# ./sdks/netcore -g csharp-netcore
# --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false
# - name: Generate .NET Full Framework client
# run:
# openapi-generator-cli generate -i ./openapi.yaml
# --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false \ -o
# ./sdks/net -g csharp
# --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false
# - name: Generate Python client
# run:
# openapi-generator-cli generate -i ./openapi.yaml
# --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false \ -o
# ./sdks/python -g python
# --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false+

docker_push:
needs:
- tests
- docker_build
# - oas-lint
# - oas-postman
# - oas-generate-sdks

needs: docker_build
name: Push Docker image
runs-on: ubuntu-latest
if: github.event_name == 'push' # Exclude PRs

steps:
# This will include the updated OAS (if updated) from the update-oas job.
- uses: actions/checkout@v3

- name: Download built image
Expand All @@ -274,13 +107,10 @@ jobs:
- name: Set tag
id: vars
run: |
# Strip git ref prefix from version
VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
# Strip "v" prefix from tag name (if present at all)
[[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
# Use Docker `latest` tag convention
[ "$VERSION" == "main" ] && VERSION=latest
echo "tag=${VERSION}" >> $GITHUB_OUTPUT
Expand All @@ -290,9 +120,7 @@ jobs:
docker image load -i image.tar
- name: Log into registry
run:
echo "${{ secrets.DOCKER_TOKEN }}" | docker login -u ${{ secrets.DOCKER_USERNAME }}
--password-stdin
run: echo "${{ secrets.DOCKER_TOKEN }}" | docker login -u ${{ secrets.DOCKER_USERNAME }} --password-stdin

- name: Push the Docker image (production)
run: docker push $IMAGE_NAME:$RELEASE_VERSION
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/code_quality.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
- name: Set up backend environment
uses: maykinmedia/setup-django-backend@v1
with:
python-version: '3.10'
python-version: '3.9'
setup-node: 'no'
- uses: isort/isort-action@v1.1.0
with:
Expand All @@ -47,7 +47,7 @@ jobs:
- name: Set up backend environment
uses: maykinmedia/setup-django-backend@v1
with:
python-version: '3.10'
python-version: '3.9'
setup-node: 'no'
- name: Run black
run: black --check src docs bin
Expand All @@ -61,7 +61,7 @@ jobs:
- name: Set up backend environment
uses: maykinmedia/setup-django-backend@v1
with:
python-version: '3.10'
python-version: '3.9'
setup-node: 'no'
- name: Run flake8
id: flake8
Expand Down Expand Up @@ -103,7 +103,7 @@ jobs:
- name: Set up backend environment
uses: maykinmedia/setup-django-backend@v1
with:
python-version: '3.10'
python-version: '3.9'
setup-node: 'no'
- name: Run makemigrations to check for missing migrations
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/macos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.10'
python-version: '3.9'
cache: 'pip'
cache-dependency-path: 'requirements/*.txt'
- name: Install OS-level packages
Expand Down
10 changes: 5 additions & 5 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# Stage 1 - Backend build environment
# includes compilers and build tooling to create the environment
FROM python:3.10.9-slim-bullseye AS backend-build
FROM python:3.9-slim-bullseye AS backend-build

RUN apt-get update && apt-get install -y --no-install-recommends \
pkg-config \
Expand All @@ -24,7 +24,7 @@ RUN pip install -r requirements/production.txt


# Stage 2 - Install frontend deps and build assets
FROM node:13-buster AS frontend-build
FROM node:18-buster AS frontend-build

RUN apt-get update && apt-get install -y --no-install-recommends \
git \
Expand All @@ -47,7 +47,7 @@ RUN npm run build


# Stage 3 - Build docker image suitable for production
FROM python:3.10.9-slim-bullseye
FROM python:3.9-slim-bullseye

# Stage 3.1 - Set up the needed production dependencies
# install all the dependencies for GeoDjango
Expand All @@ -73,7 +73,7 @@ RUN mkdir /app/media
VOLUME ["/app/log", "/app/media"]

# copy backend build deps
COPY --from=backend-build /usr/local/lib/python3.10 /usr/local/lib/python3.10
COPY --from=backend-build /usr/local/lib/python3.9 /usr/local/lib/python3.9
COPY --from=backend-build /usr/local/bin/uwsgi /usr/local/bin/uwsgi
# Uncomment if you use celery
# COPY --from=backend-build /usr/local/bin/celery /usr/local/bin/celery
Expand Down Expand Up @@ -102,7 +102,7 @@ ENV RELEASE=${RELEASE} \
ARG SECRET_KEY=dummy

LABEL org.label-schema.vcs-ref=$COMMIT_HASH \
org.label-schema.vcs-url="https://bitbucket.org/maykinmedia/bobvance" \
org.label-schema.vcs-url="https://github.com/erhancitil/bobvance" \
org.label-schema.version=$RELEASE \
org.label-schema.name="bobvance"

Expand Down
Loading

0 comments on commit e5edcdf

Please sign in to comment.