Skip to content

Latest commit

 

History

History
203 lines (161 loc) · 6.85 KB

action.md

File metadata and controls

203 lines (161 loc) · 6.85 KB
Raw

Action

Using this action requires proper directory structure and configured .bgforge.yml. Reference for Fallout, Infinity Engine.

Options

Main

Commonly used options.

name default description
poify false Run poify.py.
unpoify false Run unpoify.py.
single_commit false All changes made by the action in a single run will be put together into a single commit. Supercedes all other *_commit options.

Additional

Usually you don't need to change these options, but in some workflows that may be desirable.

name default description
poify_commit true Commit poify.py result.
unpoify_commit true Commit unpoify.py result.
dir2msgstr false For power users. Enable this only if you're sure that you understand what it does and how it works.
dir2msgstr_commit true Commit dir2msgstr.py result.
push true Push the changes.

Simple

This is a simple configuration that should work for most use cases.

name: Poify/Unpoify
on:
  push:
    paths:
      - "data/text/**" # tra_dir

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Poify/Unpoify
        uses: BGforgeNet/msg2po@master
        with:
          poify: true
          unpoify: true
          single_commit: true

Standard

In this configuration, there are 2 steps:

  • Actual run with commit and push, launched only commits to master branch.
  • Test run, launched on push to non-master branches and pull requests. It just checks changes to translation files for well-formedness.

This combination allows to reduce commit noise in repositories with a lot of activity.

# poify.yml

name: Poify/Unpoify

on:
  push:
    paths:
      - "data/text/**"
  pull_request:
    paths:
      - "data/text/**"

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Poify/Unpoify run
        if: github.ref == 'refs/heads/master' && github.event_name == 'push'
        uses: BGforgeNet/msg2po@master
        with:
          poify: true
          unpoify: true
          single_commit: true

      - name: Poify/Unpoify test
        if: (github.ref != 'refs/heads/master' && github.event_name == 'push') || github.event_name == 'pull_request'
        uses: BGforgeNet/msg2po@master
        with:
          poify: true
          unpoify: true
          dir2msgstr: true
          push: false

Advanced

If for some reason standard configurations don't fit your workflow, check the following examples to see how else the action can be used.

Poify

Poify scans source language strings and regenerates POT file. Then it merges POs with updated POT, which allows translators to see new and changed strings.

name: poify
on:
  push:
    paths:
      - "data/text/english/*/*.msg"
      - "data/text/english/*/*.sve"
      - "data/text/english/*/*.txt"

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: BGforgeNet/msg2po@master
        with:
          poify: true
          poify_commit: true

Unpoify

Unpoify extracts translations from PO files into msg/tra, etc.

name: unpoify
on:
  push:
    paths:
      - "data/text/po/*.po"
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: BGforgeNet/msg2po@master
        with:
          unpoify: true
          unpoify_commit: true

Dir2msgstr

Dir2msgstr scans translation files for strings changed outside of translation system and attempts to load them into PO files.

This is an experimental step. For local translation, consider working with PO files directly instead.

If you choose to use dir2msgstr, you might run into merge conflicts or other irregularities - as in any case when there are multiple sources of truth. You might have to resolve them manually. To reduce the chance of that happening, do not push changes to multiple sources of truth (e.g both source and translation files) at the same time.

name: dir2msgstr
on:
  push:
    paths:
      - "data/text/*/*/*.msg"
      - "data/text/*/*/*.sve"
      - "data/text/*/*/*.txt"
      - "!data/text/english/*/*.msg" # exclude source language, since we don't need to update POs in that case
      - "!data/text/english/*/*.sve"
      - "!data/text/english/*/*.txt"
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: BGforgeNet/msg2po@master
        with:
          dir2msgstr: true
          dir2msgstr_commit: true

Also, if your translation files are not in utf-8 (classic Fallouts, IE games), it's recommended to keep source strings in ASCII, or close to it, to avoid issues with characters missing in some charsets when extracting incomplete translations.

Handle charsets

You can also run handle-charsets in the same job, set handle_charsets: true for that. Same parameters, same defaults. Prepend prefix handle_charsets_ to parameter names:

  • handle_charsets_tra_path
  • handle_charsets_out_path
  • handle_charsets_from_utf8
  • handle_charsets_split_console
  • handle_charsets_commit

If single_commit is enabled, it'll also include handle-charsets changes.