Release version 6.1.0. (#1037)

This highlight support for the Bazel build system.

.bcr/presubmit.yml

@@ -1,25 +1,24 @@
 # Copyright 2025 Arthur Sonzogni. All rights reserved.
 # Use of this source code is governed by the MIT license that can be found in
 # the LICENSE file.
-bcr_test_module:
-  module_path: "."
-  matrix:
-    platform: [
-      "debian11",
-      "macos",
-      "macos-arm64",
-      "ubuntu2204",
-      "windows",
-    ]
-    bazel: [
-      6.x,
-      7.x,
-      8.x,
-    ]
-  tasks:
-    run_tests:
-      name: "Run test module"
-      platform: ${{ platform }}
-      bazel: ${{ bazel }}
-      test_targets:
-        - "//..."
+matrix:
+  platform:
+  - centos7
+  - debian10
+  - ubuntu2004
+  - macos
+  - windows
+  bazel: [6.x, 7.x, 8.x]
+tasks:
+  verify_targets:
+    name: Build and test.
+    platform: ${{ platform }}
+    bazel: ${{ bazel }}
+    build_targets:
+    - '@ftxui//:ftxui'
+    - '@ftxui//:screen'
+    - '@ftxui//:dom'
+    - '@ftxui//:component'
+    test_targets:
+    - '@ftxui//:tests'
+

.bcr/source.template.json

@@ -1,5 +1,5 @@
 {
   "integrity": "",
-  "strip_prefix": "{REPO}-{VERSION}",
-  "url": "https://github.com/{OWNER}/{REPO}/releases/download/{TAG}/{REPO}-{TAG}.tar.gz"
+  "strip_prefix": "",
+  "url": "https://github.com/ArthurSonzogni/FTXUI/releases/download/{TAG}/source.tar.gz"
 }

.github/workflows/build.yaml

@@ -12,7 +12,7 @@ on:
 jobs:
 
   test_bazel:
-    name: "Test Bazel"
+    name: "Bazel, ${{ matrix.compiler }}, ${{ matrix.os }}"
     strategy:
       fail-fast: false
       matrix:
@@ -44,7 +44,7 @@ jobs:
         run: bazel run tests
 
   test_cmake:
-    name: "Tests CMake"
+    name: "CMake, ${{ matrix.compiler }}, ${{ matrix.os }}"
     strategy:
       fail-fast: false
       matrix:
@@ -173,7 +173,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   # Build artifact for the release
-  package:
+  package_compiled:
     name: "Build packages"
     needs: release
     strategy:
@@ -217,6 +217,29 @@ jobs:
           upload_url: ${{ needs.release.outputs.upload_url }}
           asset_path: ${{ matrix.asset_path }}
           overwrite: true
+
+  # Build "source" artifact for the release. This is the same as the github
+  # "source" archive, but with a stable URL. This is useful for the Bazel
+  # Central Repository.
+  package_source:
+    name: "Build source package"
+    needs: release
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout repository"
+        uses: actions/checkout@v3
+
+      - name: "Create source package"
+        run: >
+          git archive --format=tar.gz --prefix=ftxui/ -o source.tar.gz HEAD
+
+      - name: "Upload source package"
+        uses: shogo82148/actions-upload-release-asset@v1
+        with:
+          upload_url: ${{ needs.release.outputs.upload_url }}
+          asset_path: source.tar.gz
+          overwrite: true
+
   
   documentation:
     if: github.ref == 'refs/heads/main'

.github/workflows/publish.yaml

@@ -1,12 +1,12 @@
 on:
-  # Run the publish workflow after a successful release.
+  # On new releases:
   workflow_call:
     inputs:
       tag_name:
         required: true
         type: string
 
-  # Allow manual triggering of the workflow.
+  # On manual trigger:
   workflow_dispatch:
     inputs:
       tag_name:
@@ -15,10 +15,9 @@ on:
 
 jobs:    
   publish:
-    uses: bazel-contrib/publish-to-bcr/.github/workflows/publish.yaml@[version]
+    uses: bazel-contrib/publish-to-bcr/.github/workflows/publish.yaml@v0.0.4
     with:
       tag_name: ${{ inputs.tag_name }}
-      # GitHub repository which is a fork of the upstream where the Pull Request will be opened.
       registry_fork: ArthurSonzogni/bazel-central-registry
     permissions:
       attestations: write

BUILD.bazel

@@ -3,13 +3,9 @@
 # the LICENSE file.
 
 # TODO:
-# - Windows/MSVC support.
-#   - Pass /utf-8 to MSVC users depending on FTXUI.
-#   - Pass "FTXUI_MICROSOFT_TERMINAL_FALLBACK" to windows users.
-# - Support building benchmark.
-# - Support building examples.
-# - Support building fuzzer.
-# - Support building documentation.
+# - Build benchmark.
+# - Build fuzzers.
+# - Build documentation.
 # - Enable the two tests timing out.
 # - Support WebAssembly
 
@@ -17,7 +13,7 @@ load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library", "cc_test")
 load(":bazel/ftxui.bzl", "ftxui_cc_library")
 load(":bazel/ftxui.bzl", "generate_examples")
 load(":bazel/ftxui.bzl", "cpp20")
-load(":bazel/ftxui.bzl", "msvc_copts")
+load(":bazel/ftxui.bzl", "windows_copts")
 load(":bazel/ftxui.bzl", "pthread_linkopts")
 
 package(default_visibility = ["//visibility:public"])
@@ -245,7 +241,7 @@ cc_test(
         "include",
         "src",
     ],
-    copts = cpp20() + msvc_copts(),
+    copts = cpp20() + windows_copts(),
     deps = [
         "//:ftxui",
         "@googletest//:gtest_main",

CHANGELOG.md

@@ -1,11 +1,35 @@
 Changelog
 =========
 
-Next release (2025-04-01)
--------------------------
+Future release
+------------
+
+6.1.0 (2025-04-29)
+-----------------
 
 ### Build
-- Feature: Support `bazel`. See #1032. Proposed by @kcc.
+- Feature: Support `bazel` build system. See #1032.
+  Proposed by Kostya Serebryany @kcc
+  If all goes well (pending), it should appear in the Bazel central repository.
+  It can be imported into your project using the following lines:
+
+  **MODULE.bazel**
+  ```bazel
+  bazel_dep(name = "ftxui", version = "6.1.0")
+  ```
+
+  **BUILD.bazel**
+  ```bazel
+  deps = [
+    // Depend on the whole library:
+    "@ftxui//:ftxui",
+
+    // Choose a specific submodule:
+    "@ftxui//:component",
+    "@ftxui//:dom",
+    "@ftxui//:screen",
+  ]
+  ```
 
 ### Component
 - Bugfix: Fix a crash with ResizeableSplit. See #1023.

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.12)
 
 project(ftxui
   LANGUAGES CXX
-  VERSION 6.0.2
+  VERSION 6.1.0
   DESCRIPTION "C++ Functional Terminal User Interface."
 )
 

MODULE.bazel

@@ -3,7 +3,7 @@
 # the LICENSE file.
 
 # FTXUI Module.
-module(name = "ftxui", version = "6.0.3")
+module(name = "ftxui", version = "6.1.0")
 
 # Build deps.
 bazel_dep(name = "rules_cc", version = "0.1.1")

README.md

@@ -372,7 +372,7 @@ include(FetchContent)
 
 FetchContent_Declare(ftxui
   GIT_REPOSITORY https://github.com/ArthurSonzogni/ftxui
-  GIT_TAG v6.0.2
+  GIT_TAG v6.1.0
 )
 
 FetchContent_GetProperties(ftxui)

bazel/ftxui.bzl

@@ -20,23 +20,42 @@ def cpp20():
         "//conditions:default": ["-std=c++20"],
     })
 
-def msvc_copts():
+# Microsoft terminal is a bit buggy ¯\_(ツ)_/¯ and MSVC uses bad defaults.
+def windows_copts():
     MSVC_COPTS = [
-      # Force Microsoft Visual Studio to decode sources files in UTF-8.
+      # Microsoft Visual Studio must decode sources files as UTF-8.
       "/utf-8",
 
-      # Force Microsoft Visual Studio to interpret the source files as
-      # Unicode.
+      # Microsoft Visual Studio must interpret the codepoint using unicode.
       "/DUNICODE",
       "/D_UNICODE",
 
       # Fallback for Microsoft Terminal.
+      # This
+      # - Replace missing font symbols by others.
+      # - Reduce screen position pooling frequency to deals against a Microsoft
+      #   race condition. This was fixed in 2020, but clients never not updated.
+      #   - https://github.com/microsoft/terminal/pull/7583
+      #   - https://github.com/ArthurSonzogni/FTXUI/issues/136
       "/DFTXUI_MICROSOFT_TERMINAL_FALLBACK",
     ]
+
+    WINDOWS_COPTS = [
+      # Fallback for Microsoft Terminal.
+      # This
+      # - Replace missing font symbols by others.
+      # - Reduce screen position pooling frequency to deals against a Microsoft
+      #   race condition. This was fixed in 2020, but clients never not updated.
+      #   - https://github.com/microsoft/terminal/pull/7583
+      #   - https://github.com/ArthurSonzogni/FTXUI/issues/136
+      "-DFTXUI_MICROSOFT_TERMINAL_FALLBACK",
+    ];
     
     return select({
+        # MSVC:
         "@rules_cc//cc/compiler:msvc-cl": MSVC_COPTS,
         "@rules_cc//cc/compiler:clang-cl": MSVC_COPTS,
+        "@platforms//os:windows": WINDOWS_COPTS,
         "//conditions:default": [],
     })
 
@@ -69,10 +88,12 @@ def ftxui_cc_library(
             "include",
             "src",
         ],
-        copts = cpp17() + msvc_copts(),
+        copts = cpp17() + windows_copts(),
         visibility = ["//visibility:public"],
     )
 
+# Compile all the examples in the examples/ directory.
+# This is useful to check the Bazel is synchronized with CMake definitions.
 def generate_examples():
     cpp_files = native.glob(["examples/**/*.cpp"])
 
@@ -90,5 +111,5 @@ def generate_examples():
             name = name,
             srcs = [src],
             deps = ["//:component"],
-            copts = cpp20() + msvc_copts(),
+            copts = cpp20() + windows_copts(),
         )