Skip to content
flag

GitHub Action

PointFire Localizer

v1.0.0 Latest version

PointFire Localizer

flag

PointFire Localizer

Translate your SharePoint Framework localization files

Installation

Copy and paste the following snippet into your .yml file.

              

- name: PointFire Localizer

uses: IceFireStudios/pointfire-localizer-action@v1.0.0

Learn more about this action in IceFireStudios/pointfire-localizer-action

Choose a version

PointFire Localizer

The PointFire Localizer is a GitHub Action which allows you to localize your SharePoint Framework (SPFx) solutions with the help of the Azure AI Translator.

Inputs

api-key

Required The API key for the Azure AI Translator API.

Note

You can get the API key by following the instructions on the get your authentication keys and endpoint documentation page.

api-region

Required The region of the Azure AI Translator API.

api-url

Optional The URL of the Azure AI Translator API. Default "https://api.cognitive.microsofttranslator.com/".

default-locale

Optional The default locale of the SPFx solution. Default "en-us".

locales

Optional The locales to localize the SPFx solution to (comma-separated). Default "".

Note

When you don't specify any locales, it will use the locale files found in the same directory as that of the default locale file.

summary

Optional Write to the GitHub Actions Job Summary. Default false.

Example usage

- name: PointFire Localizer
  uses: IceFireStudios/pointfire-localizer-action@v1.0.0
  with:
    api-key: ${{ secrets.TRANSLATOR_API_KEY }}
    api-region: "westeurope"
    default-locale: "en-us"
    locales: "nl-nl,fr-fr,de-de"
    summary: true