Replace the nightly build cron with an upstream language baseline check

Author: paulbalandan

.github/scripts/continuous-integration

@@ -31,16 +31,23 @@ if (! in_array($event, ['--pull-request', '--push'], true)) {
     exit(1);
 }
 
-$files = shell_exec($event === '--pull-request'
+$command = $event === '--pull-request'
     ? 'git diff --name-only --diff-filter=ACMRTUXB origin/develop..HEAD'
-    : 'git diff --name-only --diff-filter=ACMRTUXB HEAD~..HEAD');
+    : 'git diff --name-only --diff-filter=ACMRTUXB HEAD~..HEAD';
 
-if (! is_string($files)) {
-    CLI::error('Unable to retrieve the list of changed files.', 'light_gray', 'red');
+$output     = [];
+$resultCode = 0;
+
+exec($command, $output, $resultCode);
+
+if ($resultCode !== 0) {
+    CLI::error(sprintf('Unable to retrieve the list of changed files. "%s" exited with code %d.', $command, $resultCode), 'light_gray', 'red');
 
     exit(1);
 }
 
+$files = implode("\n", $output);
+
 $isCIAffected    = str_contains($files, '.github/scripts/continuous-integration');
 $isBuildAffected = str_contains($files, '.github/workflows/build.yml');
 $isTestAffected  = preg_match('/tests\/Language\/(.+)Test(?:|Case)\.php/', $files) === 1;
@@ -78,10 +85,11 @@ if ($count === 0 && ! ($isCIAffected || $isBuildAffected || $isTestAffected)) {
     exit(0);
 }
 
+$returns = 0;
+
 // Check this first to account for new ICU locale additions
 if ($count > 0 && $count < count(AbstractTranslationTestCase::$locales)) {
-    $returns = 0;
-    $return  = 0;
+    $return = 0;
 
     foreach ($locales as $locale) {
         $class = array_search($locale, AbstractTranslationTestCase::$locales, true);
@@ -109,7 +117,6 @@ if ($count > 0 && $count < count(AbstractTranslationTestCase::$locales)) {
 } elseif ($count === count(AbstractTranslationTestCase::$locales) || $isCIAffected || $isBuildAffected || $isTestAffected) {
     $count = count(AbstractTranslationTestCase::$locales);
     ob_start();
-    $returns = 0;
 
     CLI::write('Testing all language files in all locales.', 'black', 'yellow');
 
@@ -124,7 +131,7 @@ if ($count > 0 && $count < count(AbstractTranslationTestCase::$locales)) {
         CLI::write(sprintf("Reason: %s\n", $reasonMessage), 'black', 'yellow');
     }
 
-    passthru("{$phpunit} --color=always --exclude-group=auto-review", $returns);
+    passthru("{$phpunit} --color=always --exclude-group=auto-review --exclude-group=upstream", $returns);
 
     $result = ob_get_clean();
     $failed = [];

.github/workflows/build.yml

@@ -1,8 +1,6 @@
 name: build
 
 on:
-  schedule:
-    - cron: '0 0 * * *'
   push:
     branches:
       - develop
@@ -48,7 +46,7 @@ jobs:
 
       - name: Checkout other refs
         run: |
-          git fetch --no-tags --prune --depth=2 origin +refs/heads/*:refs/remotes/origin/*
+          git fetch --no-tags --prune origin +refs/heads/*:refs/remotes/origin/*
 
       - name: Setup PHP
         uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # 2.37.2

.github/workflows/upstream.yml

@@ -0,0 +1,72 @@
+name: upstream
+
+on:
+  schedule:
+    - cron: '0 3 * * *'
+  push:
+    branches:
+      - develop
+    paths:
+      - tests/Upstream/**
+      - .github/workflows/upstream.yml
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - tests/Upstream/**
+      - .github/workflows/upstream.yml
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: upstream-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  baseline:
+    name: Upstream Language Baseline [PHP ${{ matrix.php-version }}]
+    runs-on: ubuntu-24.04
+    if: github.repository == 'codeigniter4/translations'
+    timeout-minutes: 15
+
+    strategy:
+      fail-fast: false
+      # Run only on the highest supported PHP version to reduce API load
+      matrix:
+        php-version: ['8.5']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # 2.37.0
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: intl, mbstring
+          coverage: none
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache composer dependencies
+        uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
+        with:
+          path: ${{ steps.composer-cache.outputs.COMPOSER_CACHE_FILES_DIR }}
+          key: composer-PHP_${{ matrix.php-version }}-${{ hashFiles('**/composer.json') }}
+          restore-keys: composer-PHP_${{ matrix.php-version }}-
+
+      - name: Install dependencies
+        run: composer update --ansi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run Upstream Test Suite
+        run: vendor/bin/phpunit --color=always --group=upstream

.php-cs-fixer.dist.php

@@ -26,6 +26,7 @@
         'bin/generate-page',
         'bin/test',
         'bin/update-en-comments',
+        'bin/update-upstream-baseline',
     ]);
 
 $overrides = [

README.md

@@ -2,6 +2,7 @@
 
 [![build](https://github.com/codeigniter4/translations/actions/workflows/build.yml/badge.svg)](https://github.com/codeigniter4/translations/actions/workflows/build.yml)
 [![code style](https://github.com/codeigniter4/translations/actions/workflows/code-style.yml/badge.svg)](https://github.com/codeigniter4/translations/actions/workflows/code-style.yml)
+[![upstream](https://github.com/codeigniter4/translations/actions/workflows/upstream.yml/badge.svg)](https://github.com/codeigniter4/translations/actions/workflows/upstream.yml)
 [![Latest Stable Version](https://poser.pugx.org/codeigniter4/translations/v)](//packagist.org/packages/codeigniter4/translations)
 [![Total Downloads](https://poser.pugx.org/codeigniter4/translations/downloads)](//packagist.org/packages/codeigniter4/translations)
 [![License](https://poser.pugx.org/codeigniter4/translations/license)](//packagist.org/packages/codeigniter4/translations)

bin/test

@@ -72,7 +72,7 @@ CLI::write(
     'light_gray',
     'red',
 );
-exec($phpunit, $output, $resultCode);
+exec("{$phpunit} --exclude-group=upstream", $output, $resultCode);
 
 $untranslatedLocales = [];
 

bin/update-upstream-baseline

@@ -0,0 +1,89 @@
+#!/usr/bin/env php
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <admin@codeigniter.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+require __DIR__ . '/../vendor/codeigniter4/codeigniter4/system/util_bootstrap.php';
+
+use CodeIgniter\CLI\CLI;
+
+helper(['array', 'filesystem']);
+
+$enDir = __DIR__ . '/../vendor/codeigniter4/codeigniter4/system/Language/en/';
+
+if (! is_dir($enDir)) {
+    CLI::error('No "Language/en" directory. Please run "composer update".', 'light_gray', 'red');
+
+    exit(1);
+}
+
+$baseline = [];
+
+foreach (directory_map($enDir, 1) as $file) {
+    $baseline[$file] = array_keys(array_flatten_with_dots(require $enDir . $file));
+}
+
+ksort($baseline);
+
+$entries = '';
+
+foreach ($baseline as $file => $keys) {
+    $entries .= sprintf("    '%s' => [\n", $file);
+
+    foreach ($keys as $key) {
+        $entries .= sprintf("        '%s',\n", $key);
+    }
+
+    $entries .= "    ],\n";
+}
+
+$baselineFile = __DIR__ . '/../tests/Upstream/baseline.php';
+
+$contents = <<<PHP
+    <?php
+
+    declare(strict_types=1);
+
+    /**
+     * This file is part of CodeIgniter 4 framework.
+     *
+     * (c) CodeIgniter Foundation <admin@codeigniter.com>
+     *
+     * For the full copyright and license information, please view
+     * the LICENSE file that was distributed with this source code.
+     */
+
+    // @auto-generated by "php bin/update-upstream-baseline". Do not edit by hand.
+    return [
+    {$entries}];
+
+    PHP;
+
+if (file_put_contents($baselineFile, $contents) === false) {
+    CLI::error(sprintf('Failed to write the baseline to "%s".', $baselineFile), 'light_gray', 'red');
+
+    exit(1);
+}
+
+$phpCsFixer = 'vendor/bin/php-cs-fixer';
+
+if (is_windows()) {
+    $phpCsFixer = strtr($phpCsFixer, '/', '\\');
+}
+
+passthru(sprintf('%s fix --quiet tests/Upstream/baseline.php', $phpCsFixer));
+
+CLI::write(sprintf(
+    'Recorded %d language keys across %d files.',
+    array_sum(array_map(static fn (array $keys): int => count($keys), $baseline)),
+    count($baseline),
+), 'black', 'green');

composer.json

@@ -36,7 +36,8 @@
     "autoload-dev": {
         "psr-4": {
             "Translations\\Tests\\": "tests/Language/",
-            "Translations\\Tests\\AutoReview\\": "tests/AutoReview"
+            "Translations\\Tests\\AutoReview\\": "tests/AutoReview",
+            "Translations\\Tests\\Upstream\\": "tests/Upstream"
         }
     },
     "config": {

phpunit.dist.xml

@@ -18,6 +18,9 @@
         <testsuite name="Language Test Suite">
             <directory suffix="Test.php">tests/Language</directory>
         </testsuite>
+        <testsuite name="Upstream Test Suite">
+            <directory suffix="Test.php">tests/Upstream</directory>
+        </testsuite>
     </testsuites>
 
     <source ignoreIndirectDeprecations="true" restrictNotices="true" restrictWarnings="true">