kc3-lang/libxkbcommon/.github/workflows/linux.yml

Branch : - branch - android master - tag -

• Show log

  Commit

• Author : Pierre Le Marre
  Date : 2025-08-16 12:59:20
  Hash : 135b3204
  Message : compose: Add fallback for custom locales Before this commit, loading a Compose file based on the locale would fail if the locale is not in the X11 Compose locale registry. While there are workarounds (e.g. `~/.XCompose` file or `$XCOMPOSEFILE`), it does not work if the corresponding file has `include "%L"`. This commit adds the fallback `en_US.UTF-8` in case the locale is installed but not registered in the X11 Compose locale registry. The choice is motivated by the fact that most locales use `en_US.UTF-8` anyway. Ideally we should have a mechanism to extend the Compose locale registry at the *system* level. Mechanisms at the user level (e.g. custom Compose file, environment variable) are deemed sufficient. We could still improve it by first trying to fallback to the locale without the country bits, but there is no function to do such function in the stdlib and we do not want to mess with locales manually. Unfortunately is not possible to test it in our test suite. One can still check it works following these instructions: 1. Create a custom locale, e.g. `en_XX.UTF-8`. `glibc-i18ndata` or similar package may be required to get the required files in `/usr/share/i18n/`. `sudo localedef -i en_US -f UTF-8 en_XX.UTF-8` 2. `xkbcli compile-compose --verbose --locale en_XX.UTF-8`

• .github/workflows/linux.yml

• name: linux
  
  on:
    push:
      branches: [ master ]
    pull_request:
      branches: [ master ]
  
  # Set permissions at the job level.
  permissions: {}
  
  jobs:
    linux:
      runs-on: ubuntu-22.04
      permissions:
        contents: read
      strategy:
        matrix:
          compiler: [clang, gcc]
          sanitizers: ['sanitizers', 'no sanitizer']
          exclude:
            - compiler: clang
              sanitizers: sanitizers
      steps:
        - uses: actions/checkout@v4
          with:
            persist-credentials: false
        - uses: actions/setup-python@v5
          with:
            python-version: '3.12'
        - name: Install dependencies
          run: |
            # Jinja2 is needed for merge-modes tests
            python -m pip install --upgrade meson PyYAML ruff Jinja2
            sudo apt update
            sudo apt install -y \
              locales tzdata \
              doxygen libxcb-xkb-dev valgrind ninja-build \
              libwayland-dev wayland-protocols bison graphviz libicu-dev \
              ${{ matrix.sanitizers == 'sanitizers' && 'libasan8 libubsan1' || '' }}
            # Generate locale for tests
            sudo locale-gen fr_FR.UTF-8
        - name: Install xkeyboard-config
          run: |
            # Install master version of xkeyboard-config, in order to ensure
            # its latest version works well with xkbcommon.
            # HACK: We use meson to install, while it would be cleaner
            #       to create a proper package to install or use some PPA.
            pushd ~
            git clone --depth=1 https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config.git
            pushd "xkeyboard-config"
            BUILDDIR=build
            # xkeyboard-config 2.45+ uses symlinks for legacy unversioned files,
            # but meson cannot overwrite < 2.45 which used regular files and directories.
            rm /usr/share/pkgconfig/xkeyboard-config.pc
            rm -r /usr/share/X11/xkb
            meson setup $BUILDDIR -Dprefix=/usr
            meson install -C $BUILDDIR
            popd
            popd
        - name: Create custom locale for testing
          run: |
            # The locale name must be kept in sync with the Compose test
            sudo localedef -i en_US -f UTF-8 xx_YY.UTF-8
        - name: Setup
          run: |
            # -gdwarf-4 - see https://github.com/llvm/llvm-project/issues/56550.
            CFLAGS='-gdwarf-4 -fno-omit-frame-pointer' \
                meson setup -Denable-docs=true -Denable-cool-uris=true \
                            $MESON_EXTRA_FLAGS \
                            build
          env:
            CC: ${{ matrix.compiler }}
            # Use sanitizers only if not using Valgrind
            MESON_EXTRA_FLAGS: ${{ matrix.sanitizers == 'sanitizers' && '-Db_sanitize=address,undefined' || '' }}
        - name: Build
          run: |
            meson compile -C build
        - name: Test
          # Use a specific non-US locale
          run:
            LC_ALL=fr_FR.UTF-8 meson test -C build --print-errorlogs
        - name: Test with valgrind
          if: matrix.sanitizers != 'sanitizers'
          # Use a specific non-US locale
          run: |
            LC_ALL=fr_FR.UTF-8 meson test -C build --print-errorlogs --setup=valgrind \
                                                   --no-suite python-tests
        - name: Upload test logs
          uses: actions/upload-artifact@v4
          if: failure()
          with:
            name: test logs
            path: |
              build/meson-logs/
        - name: Ensure doxygen version is correct
          run: |
              doxygen --version > version.txt
              echo "1.9.6" >> version.txt
              if [ $(sort -V version.txt | tail -n1) != "1.9.6" ]; then
                  echo "Doxygen version 1.9.6 or earlier expected, see #347"
                  exit 1
              fi
        - name: Store doxygen docs for use by the pages workflow
          uses: actions/upload-artifact@v4
          if: success() && matrix.compiler == 'gcc' && matrix.sanitizers == 'sanitizers'
          with:
            name: doxygen-docs
            path: |
              build/html/
        - name: Ruff format
          run:
            ruff format --line-length=88 --check --diff .