Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opral/ninja-i18n-action
This action checks for translation issues within your PRs.
https://github.com/opral/ninja-i18n-action
github-action i18n lint
Last synced: 1 day ago
JSON representation
This action checks for translation issues within your PRs.
- Host: GitHub
- URL: https://github.com/opral/ninja-i18n-action
- Owner: opral
- License: apache-2.0
- Created: 2024-02-01T15:11:49.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-06-28T14:40:04.000Z (5 months ago)
- Last Synced: 2024-06-28T16:05:54.412Z (5 months ago)
- Topics: github-action, i18n, lint
- Homepage: https://inlang.com/m/3gk8n4n4
- Size: 1.37 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🥷 Ninja i18n [
](https://inlang.com)
Automate your i18n workflow and ensure that your i18n files are always up to date with the latest changes in your source code.
## Workflow
https://github.com/opral/monorepo/assets/59048346/99049121-11db-4672-a7a8-e0d606426f4b
- When a pull request is opened or updated, the action will run and check for new i18n issues.
- If issues are found, the action creates a comment on the pull request with an issues report including links to the Fink localization editor to resolve the issues.
- After the issues are resolved, the action will automatically update the pull request comment to reflect the changes.
- If no issues are found, the action will simply not create any comments.
## Features
- Automated i18n linting for pull requests
- Detection of new broken inlang projects
- Comment creation with issue report
- Link creation to fix issues directly in [Fink localization editor](https://inlang.com/m/tdozzpar/app-inlang-finkLocalizationEditor)
## Getting Started
Add the following workflow file to the `main` branch of your repository in this path `.github/workflows/ninja_i18n.yml`
```yml
name: Ninja i18n action
on: pull_request_target
# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
permissions:
pull-requests: write # Necessary to comment on PRs
issues: read # Necessary to read issue comments
contents: read # Necessary to access the repo content
jobs:
ninja-i18n:
name: Ninja i18n - GitHub Lint Action
runs-on: ubuntu-latest
steps:
- name: Run Ninja i18n
# @main ensures that the latest version of the action is used
uses: opral/ninja-i18n-action@main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
**Note:** Commit the workflow file to the `main` branch of your repository before testing.
### Test if it works
Create a pull request with changes to your i18n files and see if the action runs and creates a comment with the issues report:
1. Create a new `test-ninja` branch in your repository
2. Open the `test-ninja` branch in [Fink localization editor](https://fink.inlang.com) and delete a translation for testing purposes
3. Commit and push the change
4. Create a pull request from the `test-ninja` branch to `main`
5. Check if the action runs and creates a comment with the issues report
[Click here to watch a video showing the below steps in GitHub](https://www.loom.com/share/c4d15fefb0854ca4b75a85cdb0d2c7e3)
### Environmental Variables:
| Name | Requirement | Description |
| --------------------- | ----------- | ----------- |
| `GITHUB_TOKEN` | _required_ | Usage: `GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}`, Ninja i18n action uses this in-built GitHub token to make the API calls for interacting with GitHub. It is built into Github Actions and does not need to be manually specified in your secrets store. [More Info](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)|
## Troubleshooting
Please make sure that:
1. you have set up an [inlang project](https://inlang.com//documentation/concept/project) with [lint rules](https://inlang.com/c/lint-rules) in your repository
2. you have activated actions for your repository:
1. On GitHub.com, navigate to the main page of the repository
2. Click **Actions** tab
3. Click the button **Enable Actions on this repository**
3. actions and workflows are allowed in your repository:
1. On GitHub.com, navigate to the main page of the repository
2. Click **Settings** tab
3. Click **Actions** in the left sidebar, then click **General**
4. Select the desired option (e.g. **Allow all actions and workflows**) under **Actions permissions**
5. Click **Save** to apply the settings
4. if the action never reports, please make sure that the pathPattern of your plugin in the project settings is a relative path (starting with "./")