Skip to content

Commit

Permalink
feat: add GitHub workflows for building and deploying Docker image an…
Browse files Browse the repository at this point in the history
…d continuous deployment

- Added a new file `.github/workflows/build.yml` for building and deploying Docker image to GitHub Container Registry.
- Added a new file `.github/workflows/cd.yml` for handling release and deployment.
- Deleted the file `.github/workflows/ci-cd.yml`.
- Added a new file `.github/workflows/ci.yml` for continuous integration.

These changes introduce GitHub workflows to automate the build, deployment, and continuous integration processes for the project.
  • Loading branch information
MountainGod2 committed Oct 7, 2024
1 parent 4c5d9f2 commit d32ec79
Show file tree
Hide file tree
Showing 4 changed files with 182 additions and 175 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Build and Deploy Docker Image

on:
push:
branches:
- main

jobs:
build:
name: Build and Push Docker Image to GitHub Container Registry
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up QEMU for Multi-Architecture Builds
uses: docker/setup-qemu-action@v3

- name: Set up Docker Buildx for Multi-Platform Builds
uses: docker/setup-buildx-action@v3

- name: Generate Docker Image Metadata
id: meta
uses: docker/metadata-action@v5
with:
images: ghcr.io/mountaingod2/chaturbate_poller
tags: |
type=schedule
type=ref,event=branch
type=ref,event=pr
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=sha
type=raw,value=latest,enable={{is_default_branch}}
- name: Log in to GitHub Container Registry
if: github.event_name != 'pull_request'
uses: docker/login-action@v3
with:
registry: ghcr.io
username: '${{ github.repository_owner }}'
password: '${{ secrets.GITHUB_TOKEN }}'

- name: Build and Push Docker Image
uses: docker/build-push-action@v6
with:
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

- name: Run Docker Image Tests
run: docker run --rm ghcr.io/mountaingod2/chaturbate_poller:latest --version
59 changes: 59 additions & 0 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Continuous Deployment

on:
push:
branches:
- main

jobs:
cd:
name: Handle Release and Deployment
permissions:
id-token: write
contents: write
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up UV Environment
uses: astral-sh/[email protected]
with:
enable-cache: true
cache-dependency-glob: uv.lock

- name: Run Python Semantic Release
id: release
uses: python-semantic-release/[email protected]
with:
github_token: '${{ secrets.GITHUB_TOKEN }}'
git_committer_name: 'MountainGod2'
git_committer_email: '[email protected]'
ssh_private_signing_key: '${{ secrets.GIT_COMMIT_SSH_PRIV_KEY }}'
ssh_public_signing_key: '${{ secrets.GIT_COMMIT_SSH_PUB_KEY }}'

- name: Publish to TestPyPI
if: steps.release.outputs.released == 'true'
uses: pypa/gh-action-pypi-publish@release/v1
with:
repository-url: 'https://test.pypi.org/legacy/'
password: '${{ secrets.TEST_PYPI_API_TOKEN }}'

- name: Test Install from TestPyPI
if: steps.release.outputs.released == 'true'
run: |
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple chaturbate-poller
- name: Publish to PyPI
if: steps.release.outputs.released == 'true'
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: '${{ secrets.PYPI_API_TOKEN }}'

- name: Publish to GitHub Releases
if: steps.release.outputs.released == 'true'
uses: python-semantic-release/upload-to-gh-release@main
with:
github_token: '${{ secrets.GITHUB_TOKEN }}'
175 changes: 0 additions & 175 deletions .github/workflows/ci-cd.yml

This file was deleted.

68 changes: 68 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: Continuous Integration

on:
push:
branches:
- main
pull_request:
branches:
- main

env:
UV_CACHE_DIR: /tmp/.uv-cache

jobs:
ci:
name: Run Tests, Lint, Type Check, and Build Docs
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up UV Environment
uses: astral-sh/[email protected]
with:
enable-cache: true
cache-dependency-glob: uv.lock

- name: Restore UV Cache
uses: actions/cache@v4
with:
path: /tmp/.uv-cache
key: "uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}"
restore-keys: |
uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
uv-${{ runner.os }}
- name: Install Dependencies and Sync Project
run: uv sync

- name: Run Formatting, Linting, Type Checks, and Tests
run: |
uv run ruff format ./
uv run ruff check --fix ./
uv run mypy ./
uv run pytest
env:
CB_USERNAME: '${{ secrets.CB_USERNAME }}'
CB_TOKEN: '${{ secrets.CB_TOKEN }}'

- name: Upload Test Coverage to Codecov
uses: codecov/codecov-action@v4
with:
token: '${{ secrets.CODECOV_TOKEN }}'
file: ./coverage.xml
fail_ci_if_error: true

- name: Scan with SonarCloud
uses: SonarSource/[email protected]
env:
SONAR_TOKEN: '${{ secrets.SONAR_TOKEN }}'

- name: Build Documentation
run: uv run make clean html --directory docs/

- name: Minimize UV Cache
run: uv cache prune --ci

0 comments on commit d32ec79

Please sign in to comment.