benjaminjonard / crowdin-translations-progress-action

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

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.

<!-- CROWDIN-TRANSLATIONS-PROGRESS-ACTION-START -->
<!-- CROWDIN-TRANSLATIONS-PROGRESS-ACTION-END -->

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

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/[email protected]
        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

Licensing

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

crowdin-translations-progress-action's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• Update all non-major dependencies (@crowdin/crowdin-api-client, @types/node, @typescript-eslint/parser)

Detected dependencies

npm

package.json

• @actions/core ^1.10.0
• @actions/exec ^1.1.1
• @actions/github ^5.1.1
• @crowdin/crowdin-api-client ^1.22.1
• axios ^1.3.5
• dotenv ^16.0.3
• @types/node ^18.15.11
• @typescript-eslint/parser ^5.58.0
• @vercel/ncc ^0.36.1
• typescript ^5.0.4

---

• Check this box to trigger a request for Renovate to run again on this repository

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update all non-major dependencies (@crowdin/crowdin-api-client, @types/node, @typescript-eslint/parser, axios, typescript)
• Update dependency @typescript-eslint/parser to v8

Detected dependencies

npm

package.json

• @actions/core ^1.10.0
• @actions/exec ^1.1.1
• @actions/github ^6.0.0
• @crowdin/crowdin-api-client ^1.22.1
• axios ^1.3.5
• dotenv ^16.0.3
• @types/node ^20.0.0
• @typescript-eslint/parser ^7.0.0
• @vercel/ncc ^0.38.0
• typescript ^5.0.4