mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-06-10 17:45:02 +00:00
be1a9cc8da
# Description of Changes Please provide a summary of the changes, including: - **What was changed** - Removed individual `actions/create-github-app-token` steps and replaced them with a centralized `setup-bot` custom action across all workflows. - Updated steps to use `steps.setup-bot.outputs` instead of `steps.generate-token.outputs`. - Standardized step names and ordering (e.g. checkout before bot setup). - Simplified `sync_files.yml` by eliminating the `read_bot_entries` job and directly using `setup-bot` outputs. - Added or adjusted permissions where required (e.g. `repository-projects: write` in `licenses-update.yml`). - **Why the change was made** - To centralize and standardize GitHub App authentication logic, reduce duplication, and improve maintainability of CI workflows. - To ensure a consistent bot identity (app slug, token, committer/author) across all actions and PR automation. - To streamline workflow configurations and make future updates easier. --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/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/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] 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/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/DeveloperGuide.md#6-testing) for more details.
105 lines
3.7 KiB
YAML
105 lines
3.7 KiB
YAML
name: Sync Files
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- "build.gradle"
|
|
- "README.md"
|
|
- "src/main/resources/messages_*.properties"
|
|
- "src/main/resources/static/3rdPartyLicenses.json"
|
|
- "scripts/ignore_translation.toml"
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
sync-files:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Harden Runner
|
|
uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
|
|
with:
|
|
egress-policy: audit
|
|
|
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
|
|
|
- name: Setup GitHub App Bot
|
|
id: setup-bot
|
|
uses: ./.github/actions/setup-bot
|
|
with:
|
|
app-id: ${{ vars.GH_APP_ID }}
|
|
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
|
|
- name: Set up Python
|
|
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
|
|
with:
|
|
python-version: "3.12"
|
|
cache: "pip" # caching pip dependencies
|
|
|
|
- name: Sync translation property files
|
|
run: |
|
|
python .github/scripts/check_language_properties.py --reference-file "src/main/resources/messages_en_GB.properties" --branch main
|
|
|
|
- name: Commit translation files
|
|
run: |
|
|
git add src/main/resources/messages_*.properties
|
|
git diff --staged --quiet || git commit -m ":memo: Sync translation files" || echo "No changes detected"
|
|
|
|
- name: Install dependencies
|
|
run: pip install --require-hashes -r ./.github/scripts/requirements_sync_readme.txt
|
|
|
|
- name: Sync README.md
|
|
run: |
|
|
python scripts/counter_translation.py
|
|
|
|
- name: Run git add
|
|
run: |
|
|
git add README.md
|
|
git diff --staged --quiet || git commit -m ":memo: Sync README.md" || echo "No changes detected"
|
|
|
|
- name: Create Pull Request
|
|
if: always()
|
|
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
|
|
with:
|
|
token: ${{ steps.setup-bot.outputs.token }}
|
|
commit-message: Update files
|
|
committer: ${{ steps.setup-bot.outputs.committer }}
|
|
author: ${{ steps.setup-bot.outputs.committer }}
|
|
signoff: true
|
|
branch: sync_readme
|
|
title: ":globe_with_meridians: Sync Translations + Update README Progress Table"
|
|
body: |
|
|
### Description of Changes
|
|
|
|
This Pull Request was automatically generated to synchronize updates to translation files and documentation. Below are the details of the changes made:
|
|
|
|
#### **1. Synchronization of Translation Files**
|
|
- Updated translation files (`messages_*.properties`) to reflect changes in the reference file `messages_en_GB.properties`.
|
|
- Ensured consistency and synchronization across all supported language files.
|
|
- Highlighted any missing or incomplete translations.
|
|
|
|
#### **2. Update README.md**
|
|
- Generated the translation progress table in `README.md`.
|
|
- Added a summary of the current translation status for all supported languages.
|
|
- Included up-to-date statistics on translation coverage.
|
|
|
|
#### **Why these changes are necessary**
|
|
- Keeps translation files aligned with the latest reference updates.
|
|
- Ensures the documentation reflects the current translation progress.
|
|
|
|
---
|
|
|
|
Auto-generated by [create-pull-request][1].
|
|
|
|
[1]: https://github.com/peter-evans/create-pull-request
|
|
draft: false
|
|
delete-branch: true
|
|
labels: github-actions
|
|
sign-commits: true
|
|
add-paths: |
|
|
README.md
|
|
src/main/resources/messages_*.properties
|