https://github.com/benjaminjonard/crowdin-translations-progress-action

This GitHub action will add a table containing Crowdin languages translation progress in a .md file
https://github.com/benjaminjonard/crowdin-translations-progress-action

action crowdin github-actions translations

Last synced: about 2 months ago
JSON representation

This GitHub action will add a table containing Crowdin languages translation progress in a .md file

• Host: GitHub
• URL: https://github.com/benjaminjonard/crowdin-translations-progress-action
• Owner: benjaminjonard
• License: mit
• Created: 2023-04-14T16:13:31.000Z (over 2 years ago)
• Default Branch: 1.0
• Last Pushed: 2025-08-16T07:15:30.000Z (about 2 months ago)
• Last Synced: 2025-08-17T05:19:43.969Z (about 2 months ago)
• Topics: action, crowdin, github-actions, translations
• Language: TypeScript
• Homepage:
• Size: 976 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
This GitHub action will add a table containing Crowdin translations progress in a .md file

### Usage

1. Add the following lines in your .md file. the progress table will be added between those 2 lines.

```

```

2. Add a new workflow file `.github/workflows/crowdin-translations-progress.yml`

```yaml

name: Crowdin translations progress

on:

  push:

    branches: [ main ]

  schedule:

    - cron: "0 */12 * * *"

  workflow_dispatch:

jobs:

  crowdin-translations-progress:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: Generate Crowdin translations progress markdown

        uses: benjaminjonard/crowdin-translations-progress-action@1.0.7

        with:

          languages_per_row: 10

          minimum_completion_percent: 80

          file: README.md

        env:

          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}

          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

      - name: Create Pull Request

        uses: peter-evans/create-pull-request@v5

        with:

          title: Update Crowdin translations progress

          body: Update Crowdin translations progress by [Crowdin translations progress](https://github.com/benjaminjonard/crowdin-translations-progress-action) GitHub action

          commit-message: Update Crowdin translations progress

          branch: crowdin-translations-progress-action

```

## Variables

| Name                         | Default value | Description                                                                     |

|------------------------------|---------------|---------------------------------------------------------------------------------|

| `languages_per_row`          | 10            | Number of languages displayed on each row                                       |

| `minimum_completion_percent` | 80            | The minimum progress value in % the language must be to be considered available |

| `file`                       | README.md     | The targeted markdown file                                                      |

## Example

![crowdin-translations-progress-screenshot](https://user-images.githubusercontent.com/20560781/232151800-2981a8d6-86ef-4cbc-874b-c604ff3cf8e6.png)

## Licensing

crowdin-translations-progress-action is an Open Source software, released under the MIT License.