-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improves the sync of translation files and README.md (#2744)
# Description of Changes Please provide a summary of the changes, including: - What was changed - Why the change was made - Any challenges encountered Closes #(issue_number) --- ## Checklist ### General - [x] 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/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.
- Loading branch information
Showing
3 changed files
with
87 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,51 +13,123 @@ permissions: | |
contents: read | ||
|
||
jobs: | ||
sync-readme: | ||
read_bot_entries: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
pull-requests: write | ||
outputs: | ||
userName: ${{ steps.get-user-id.outputs.user_name }} | ||
userEmail: ${{ steps.get-user-id.outputs.user_email }} | ||
committer: ${{ steps.committer.outputs.committer }} | ||
steps: | ||
- name: Harden Runner | ||
uses: step-security/harden-runner@c95a14d0e5bab51a9f56296a4eb0e416910cd350 # v2.10.3 | ||
with: | ||
egress-policy: audit | ||
|
||
- name: Generate GitHub App Token | ||
id: generate-token | ||
uses: actions/create-github-app-token@c1a285145b9d317df6ced56c09f525b5c2b6f755 # v1.11.1 | ||
with: | ||
app-id: ${{ secrets.GH_APP_ID }} | ||
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} | ||
|
||
- name: Get GitHub App User ID | ||
id: get-user-id | ||
run: | | ||
USER_NAME="${{ steps.generate-token.outputs.app-slug }}[bot]" | ||
USER_ID=$(gh api "/users/$USER_NAME" --jq .id) | ||
USER_EMAIL="[email protected]" | ||
echo "user_name=$USER_NAME" >> "$GITHUB_OUTPUT" | ||
echo "user_email=$USER_EMAIL" >> "$GITHUB_OUTPUT" | ||
echo "user-id=$USER_ID" >> "$GITHUB_OUTPUT" | ||
env: | ||
GH_TOKEN: ${{ steps.generate-token.outputs.token }} | ||
|
||
- id: committer | ||
run: | | ||
COMMITTER="${{ steps.get-user-id.outputs.user_name }} <${{ steps.get-user-id.outputs.user_email }}>" | ||
echo "committer=$COMMITTER" >> "$GITHUB_OUTPUT" | ||
sync-files: | ||
needs: ["read_bot_entries"] | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Harden Runner | ||
uses: step-security/harden-runner@c95a14d0e5bab51a9f56296a4eb0e416910cd350 # v2.10.3 | ||
with: | ||
egress-policy: audit | ||
|
||
- name: Generate GitHub App Token | ||
id: generate-token | ||
uses: actions/create-github-app-token@c1a285145b9d317df6ced56c09f525b5c2b6f755 # v1.11.1 | ||
with: | ||
app-id: ${{ vars.GH_APP_ID }} | ||
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }} | ||
|
||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.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: Set up git config | ||
run: | | ||
git config --global user.name ${{ needs.read_bot_entries.outputs.userName }} | ||
git config --global user.email ${{ needs.read_bot_entries.outputs.userEmail }} | ||
- name: Run git add | ||
run: | | ||
git add . | ||
git diff --staged --quiet || git commit -m ":memo: Sync translation files" || echo "no changes" | ||
- name: Install dependencies | ||
run: pip install --require-hashes -r ./.github/scripts/requirements_sync_readme.txt | ||
|
||
- name: Sync README | ||
run: python scripts/counter_translation.py | ||
- name: Set up git config | ||
run: | | ||
git config --global user.name "github-actions[bot]" | ||
git config --global user.email "github-actions[bot]@users.noreply.github.com" | ||
python scripts/counter_translation.py | ||
- name: Run git add | ||
run: | | ||
git add . | ||
git diff --staged --quiet || git commit -m ":memo: Sync README | ||
> Made via sync_files.yml" || echo "no changes" | ||
git diff --staged --quiet || git commit -m ":memo: Sync README.md" || echo "no changes" | ||
- name: Create Pull Request | ||
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6 | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
token: ${{ steps.generate-token.outputs.token }} | ||
commit-message: Update files | ||
committer: GitHub Action <[email protected]> | ||
author: GitHub Action <[email protected]> | ||
committer: ${{ needs.read_bot_entries.outputs.committer }} | ||
author: ${{ needs.read_bot_entries.outputs.committer }} | ||
signoff: true | ||
branch: sync_readme | ||
title: ":memo: Update README: Translation Progress Table" | ||
title: ":memo: Sync translation files + Update README.md (Translation Progress Table)" | ||
body: | | ||
#### Description | ||
This Pull Request was automatically generated to synchronize updates to translation files and documentation. The changes include: | ||
1. **Synchronization of Translation Files:** | ||
- Updated content based on the latest changes in `messages_en_GB.properties`. | ||
- Ensured consistency between all language files and the reference file. | ||
2. **Update README.md:** | ||
- Generated the translation progress table. | ||
- Displayed the current status of translations for all supported languages. | ||
--- | ||
Auto-generated by [create-pull-request][1] | ||
[1]: https://github.com/peter-evans/create-pull-request | ||
draft: false | ||
delete-branch: true | ||
labels: Documentation,Translation,github-actions | ||
sign-commits: true | ||
add-paths: | | ||
README.md | ||
src/main/resources/messages_*.properties |
This file was deleted.
Oops, something went wrong.