https://github.com/ashutoshgngwr/android-translations
[Deprecated] A GitHub Action to find the missing and potentially outdated translations for existing locales in an Android Project.
https://github.com/ashutoshgngwr/android-translations
android android-translations app-localization github-actions localization
Last synced: 5 months ago
JSON representation
[Deprecated] A GitHub Action to find the missing and potentially outdated translations for existing locales in an Android Project.
- Host: GitHub
- URL: https://github.com/ashutoshgngwr/android-translations
- Owner: ashutoshgngwr
- License: apache-2.0
- Archived: true
- Created: 2020-06-02T14:55:17.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-19T14:01:41.000Z (over 5 years ago)
- Last Synced: 2025-10-22T15:31:36.060Z (8 months ago)
- Topics: android, android-translations, app-localization, github-actions, localization
- Language: Go
- Homepage: https://github.com/marketplace/actions/android-translations
- Size: 77.1 KB
- Stars: 10
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Android Translations
A GitHub Action to find the missing and _potentially_ outdated translations
for existing locales in an Android Project.
This action is the same as running the following but with a few exceptions
1. Reports can be generated in JSON. Lint tool generates XML or HTML
2. Seamless integration with GitHub actions to ease the use of generated
data
3. It's not easy to [run the standalone lint tool on a Gradle project
](https://stackoverflow.com/q/62149318/2410641)
4. It checks Git blame to find outdated translations
```sh
${ANDROID_HOME}/tools/bin/lint --check MissingTranslation ${PROJECT_DIR}
```
## Features
- Almost zero config
- Find outdated translations
- Generate reports in Markdown or JSON format
- Usable in other CI environments
## Usage
The following workflow covers one possible use-case for this action.
It uses the action to find the missing translations and generate a report
in Markdown format. In the next step, it creates a comment on issue #1
with the generated report as its body.
```yaml
on: [push]
jobs:
check-translations:
name: Check Translations
# Linux is required since this is a docker container action
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- id: check_translations
uses: ashutoshgngwr/android-translations@v1
with:
projectDir: ./
- name: Add comment
uses: peter-evans/create-or-update-comment@v1
with:
issue-number: 1
body: ${{ steps.check_translations.outputs.report }}
```
### Input
The action can accept the following input parameters
| Key | Description | Default Value |
| ----------------- | ---------------------------------------------------- | ---------------------- |
| `projectDir` | Android Project's root directory | `.` |
| `outdatedLocales` | If true, also find potentially outdated translations | `true` |
| `outputFormat` | Must be one of `json` or `markdown` | `markdown` |
| `markdownTitle` | Title for the Markdown content (not used with JSON) | `Missing Translations` |
### Output
The action produces the following output which can be used in the next steps
or jobs. See [`steps` context](https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#needs-context)
and [`needs` context](https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#needs-context).
In addition to this, the action also prints the same output to `stdout`.
| Key | Description |
| -------- | -------------------------------------------------------------------- |
| `report` | The missing translations report for strings in the requested format. |
#### JSON Report Format
The following structure is used while generating JSON reports.
```json
[
{
"name": "example_1",
"value": "Example 1",
"missing_locales": [
"ru",
"pt-rBR"
],
"outdated_locales": [
"cs",
"de"
]
},
{
"name": "example_2",
"value": "Example 2",
"missing_locales": [
"sv",
"de"
],
"outdated_locales": []
},
{
"name": "example_2",
"value": "Example 3",
"missing_locales": [],
"outdated_locales": [
"pt-rBR",
"ru"
]
}
]
```
### Using Without GitHub Actions
**Caution:** The action is designed to run on projects that are part of a Git repository.
```sh
docker run --rm --workdir /app --mount type=bind,source="$(pwd)",target=/app \
ashutoshgngwr/android-translations:v1 --output-format=json
```
## License
[Apache License 2.0](/LICENSE)