mirror of
https://github.com/Frooodle/Stirling-PDF.git
synced 2026-02-01 20:10:35 +01:00
# Description of Changes This pull request updates dependency management and CI/CD configurations to improve automation, security, and maintainability. The most significant changes include expanding Dependabot coverage to more directories and ecosystems, updating pre-commit and Python dependency versions, and pinning action versions in GitHub workflows for better reproducibility and security. **Dependency Management Improvements:** * Expanded Dependabot configuration in `.github/dependabot.yml` to include additional directories and package ecosystems such as npm, docker, cargo, and pip, ensuring automated dependency updates across more parts of the project. * Updated Python dependencies in `.github/scripts/requirements_pre_commit.txt` to newer versions for `cfgv`, `filelock`, `platformdirs`, `pre-commit`, and `virtualenv`, improving compatibility and security. [[1]](diffhunk://#diff-4b865d764c6955aa3ab06c7beff7c08a122e5145c1f0fecd7b4fd4575848b598L7-R17) [[2]](diffhunk://#diff-4b865d764c6955aa3ab06c7beff7c08a122e5145c1f0fecd7b4fd4575848b598L27-R33) [[3]](diffhunk://#diff-4b865d764c6955aa3ab06c7beff7c08a122e5145c1f0fecd7b4fd4575848b598L110-R112) * Added `tomli-w` to `.github/scripts/requirements_sync_readme.in` and `.github/scripts/requirements_sync_readme.txt` for TOML file writing support. [[1]](diffhunk://#diff-e359c7d332d374a67300c004d7bab6c37cb16b5e1b9c8cd63adf2b59462c1f06R2) [[2]](diffhunk://#diff-cf0fa825b1295e115dbbe842a6f179ed0c72dd80b758d3238ab792cdd0013a4cR7-R10) **CI/CD Workflow Enhancements:** * Updated installation commands in `.github/workflows/check_toml.yml` and `.github/workflows/sync_files_v2.yml` to use hashed and version-pinned dependencies, improving reproducibility and security. Also removed redundant dependency installation in the sync workflow. [[1]](diffhunk://#diff-3117b4a93711d37b0a9a1668272eec716fea0b4f57dde16a85e7ab3f569c455dL203-R203) [[2]](diffhunk://#diff-b1acd58f6bdc16d0f02514058f8842a8ec3c90e8771f6a1e83801fa14ee5041cL56-R56) [[3]](diffhunk://#diff-b1acd58f6bdc16d0f02514058f8842a8ec3c90e8771f6a1e83801fa14ee5041cL68-L70) * Pinned GitHub Actions versions in `.github/workflows/deploy-on-v2-commit.yml` by using commit SHAs for actions such as `actions/checkout`, `docker/setup-buildx-action`, `docker/login-action`, and `docker/build-push-action`, ensuring builds use known-good versions. [[1]](diffhunk://#diff-f8b6ec3c0af9cd2d8dffef6f3def2be6357fe596a606850ca7f5d799e1349069L26-R29) [[2]](diffhunk://#diff-f8b6ec3c0af9cd2d8dffef6f3def2be6357fe596a606850ca7f5d799e1349069L89-R96) [[3]](diffhunk://#diff-f8b6ec3c0af9cd2d8dffef6f3def2be6357fe596a606850ca7f5d799e1349069L109-R109) **Pre-commit Configuration Updates:** * Updated hooks in `.pre-commit-config.yaml` to newer versions for `ruff-pre-commit`, `gitleaks`, and `pre-commit-hooks`, providing enhanced linting and security scanning. [[1]](diffhunk://#diff-63a9c44a44acf85fea213a857769990937107cf072831e1a26808cfde9d096b9L3-R3) [[2]](diffhunk://#diff-63a9c44a44acf85fea213a857769990937107cf072831e1a26808cfde9d096b9L25-R29) --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details.
190 lines
7.1 KiB
YAML
190 lines
7.1 KiB
YAML
name: Auto V2 Deploy on Push
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- V2
|
|
- deploy-on-v2-commit
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
deploy-v2-on-push:
|
|
runs-on: ubuntu-latest
|
|
concurrency:
|
|
group: deploy-v2-push-V2
|
|
cancel-in-progress: true
|
|
|
|
steps:
|
|
- name: Harden Runner
|
|
uses: step-security/harden-runner@002fdce3c6a235733a90a27c80493a3241e56863 # v2.12.1
|
|
with:
|
|
egress-policy: audit
|
|
|
|
- name: Checkout code
|
|
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
|
|
|
- name: Set up Docker Buildx
|
|
uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1
|
|
|
|
- name: Get commit hashes for frontend and backend
|
|
id: commit-hashes
|
|
run: |
|
|
# Get last commit that touched the frontend folder, docker/frontend, or docker/compose
|
|
FRONTEND_HASH=$(git log -1 --format="%H" -- frontend/ docker/frontend/ docker/compose/ 2>/dev/null || echo "")
|
|
if [ -z "$FRONTEND_HASH" ]; then
|
|
FRONTEND_HASH="no-frontend-changes"
|
|
fi
|
|
|
|
# Get last commit that touched backend code, docker/backend, or docker/compose
|
|
BACKEND_HASH=$(git log -1 --format="%H" -- app/ docker/backend/ docker/compose/ 2>/dev/null || echo "")
|
|
if [ -z "$BACKEND_HASH" ]; then
|
|
BACKEND_HASH="no-backend-changes"
|
|
fi
|
|
|
|
echo "Frontend hash: $FRONTEND_HASH"
|
|
echo "Backend hash: $BACKEND_HASH"
|
|
|
|
echo "frontend_hash=$FRONTEND_HASH" >> $GITHUB_OUTPUT
|
|
echo "backend_hash=$BACKEND_HASH" >> $GITHUB_OUTPUT
|
|
|
|
# Short hashes for tags
|
|
if [ "$FRONTEND_HASH" = "no-frontend-changes" ]; then
|
|
echo "frontend_short=no-frontend" >> $GITHUB_OUTPUT
|
|
else
|
|
echo "frontend_short=${FRONTEND_HASH:0:8}" >> $GITHUB_OUTPUT
|
|
fi
|
|
|
|
if [ "$BACKEND_HASH" = "no-backend-changes" ]; then
|
|
echo "backend_short=no-backend" >> $GITHUB_OUTPUT
|
|
else
|
|
echo "backend_short=${BACKEND_HASH:0:8}" >> $GITHUB_OUTPUT
|
|
fi
|
|
|
|
- name: Check if frontend image exists
|
|
id: check-frontend
|
|
run: |
|
|
if docker manifest inspect ${{ secrets.DOCKER_HUB_USERNAME }}/test:v2-frontend-${{ steps.commit-hashes.outputs.frontend_short }} >/dev/null 2>&1; then
|
|
echo "exists=true" >> $GITHUB_OUTPUT
|
|
echo "Frontend image already exists, skipping build"
|
|
else
|
|
echo "exists=false" >> $GITHUB_OUTPUT
|
|
echo "Frontend image needs to be built"
|
|
fi
|
|
|
|
- name: Check if backend image exists
|
|
id: check-backend
|
|
run: |
|
|
if docker manifest inspect ${{ secrets.DOCKER_HUB_USERNAME }}/test:v2-backend-${{ steps.commit-hashes.outputs.backend_short }} >/dev/null 2>&1; then
|
|
echo "exists=true" >> $GITHUB_OUTPUT
|
|
echo "Backend image already exists, skipping build"
|
|
else
|
|
echo "exists=false" >> $GITHUB_OUTPUT
|
|
echo "Backend image needs to be built"
|
|
fi
|
|
|
|
|
|
- name: Login to Docker Hub
|
|
uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
|
|
with:
|
|
username: ${{ secrets.DOCKER_HUB_USERNAME }}
|
|
password: ${{ secrets.DOCKER_HUB_API }}
|
|
|
|
- name: Build and push frontend image
|
|
if: steps.check-frontend.outputs.exists == 'false'
|
|
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
|
|
with:
|
|
context: .
|
|
file: ./docker/frontend/Dockerfile
|
|
push: true
|
|
tags: |
|
|
${{ secrets.DOCKER_HUB_USERNAME }}/test:v2-frontend-${{ steps.commit-hashes.outputs.frontend_short }}
|
|
${{ secrets.DOCKER_HUB_USERNAME }}/test:v2-frontend-latest
|
|
build-args: VERSION_TAG=v2-alpha
|
|
platforms: linux/amd64
|
|
|
|
- name: Build and push backend image
|
|
if: steps.check-backend.outputs.exists == 'false'
|
|
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
|
|
with:
|
|
context: .
|
|
file: ./docker/backend/Dockerfile
|
|
push: true
|
|
tags: |
|
|
${{ secrets.DOCKER_HUB_USERNAME }}/test:v2-backend-${{ steps.commit-hashes.outputs.backend_short }}
|
|
${{ secrets.DOCKER_HUB_USERNAME }}/test:v2-backend-latest
|
|
build-args: VERSION_TAG=v2-alpha
|
|
platforms: linux/amd64
|
|
|
|
|
|
- name: Set up SSH
|
|
run: |
|
|
mkdir -p ~/.ssh/
|
|
echo "${{ secrets.VPS_SSH_KEY }}" > ../private.key
|
|
chmod 600 ../private.key
|
|
|
|
|
|
- name: Deploy to VPS on port 3000
|
|
run: |
|
|
export UNIQUE_NAME=docker-compose-v2-$GITHUB_RUN_ID.yml
|
|
|
|
cat > $UNIQUE_NAME << EOF
|
|
version: '3.3'
|
|
services:
|
|
backend:
|
|
container_name: stirling-v2-backend
|
|
image: ${{ secrets.DOCKER_HUB_USERNAME }}/test:v2-backend-${{ steps.commit-hashes.outputs.backend_short }}
|
|
ports:
|
|
- "13000:8080"
|
|
volumes:
|
|
- /stirling/V2/data:/usr/share/tessdata:rw
|
|
- /stirling/V2/config:/configs:rw
|
|
- /stirling/V2/logs:/logs:rw
|
|
environment:
|
|
DISABLE_ADDITIONAL_FEATURES: "true"
|
|
SECURITY_ENABLELOGIN: "false"
|
|
SYSTEM_DEFAULTLOCALE: en-GB
|
|
UI_APPNAME: "Stirling-PDF V2"
|
|
UI_HOMEDESCRIPTION: "V2 Frontend/Backend Split"
|
|
UI_APPNAMENAVBAR: "V2 Deployment"
|
|
SYSTEM_MAXFILESIZE: "100"
|
|
METRICS_ENABLED: "true"
|
|
SYSTEM_GOOGLEVISIBILITY: "false"
|
|
SWAGGER_SERVER_URL: "https://demo.stirlingpdf.cloud"
|
|
baseUrl: "https://demo.stirlingpdf.cloud"
|
|
restart: on-failure:5
|
|
|
|
frontend:
|
|
container_name: stirling-v2-frontend
|
|
image: ${{ secrets.DOCKER_HUB_USERNAME }}/test:v2-frontend-${{ steps.commit-hashes.outputs.frontend_short }}
|
|
ports:
|
|
- "3000:80"
|
|
environment:
|
|
VITE_API_BASE_URL: "http://${{ secrets.VPS_HOST }}:13000"
|
|
depends_on:
|
|
- backend
|
|
restart: on-failure:5
|
|
EOF
|
|
|
|
# Copy to remote with unique name
|
|
scp -i ../private.key -o StrictHostKeyChecking=no $UNIQUE_NAME ${{ secrets.VPS_USERNAME }}@${{ secrets.VPS_HOST }}:/tmp/$UNIQUE_NAME
|
|
|
|
# SSH and rename/move atomically to avoid interference
|
|
ssh -i ../private.key -o StrictHostKeyChecking=no ${{ secrets.VPS_USERNAME }}@${{ secrets.VPS_HOST }} << ENDSSH
|
|
mkdir -p /stirling/V2/{data,config,logs}
|
|
mv /tmp/$UNIQUE_NAME /stirling/V2/docker-compose.yml
|
|
cd /stirling/V2
|
|
docker-compose down || true
|
|
docker-compose pull
|
|
docker-compose up -d
|
|
docker system prune -af --volumes || true
|
|
docker image prune -af --filter "until=336h" --filter "label!=keep=true" || true
|
|
ENDSSH
|
|
|
|
- name: Cleanup temporary files
|
|
if: always()
|
|
run: |
|
|
rm -f ../private.key
|
|
|