refactor: Rename rippled binary to xrpld and add symlink

.github/scripts/rename/README.md

@@ -26,6 +26,9 @@ run from the repository root.
    references to `ripple` and `rippled` (with or without capital letters) to
    `xrpl` and `xrpld`, respectively. The name of the binary will remain as-is,
    and will only be renamed to `xrpld` by a later script.
+4. `.github/scripts/rename/binary.sh`: This script will rename the binary from
+   `rippled` to `xrpld`, and create a symlink named `rippled` that points to the
+   `xrpld` binary.
 
 You can run all these scripts from the repository root as follows:
 
@@ -33,4 +36,5 @@ You can run all these scripts from the repository root as follows:
 ./.github/scripts/rename/definitions.sh .
 ./.github/scripts/rename/copyright.sh .
 ./.github/scripts/rename/cmake.sh .
+./.github/scripts/rename/binary.sh .
 ```

.github/scripts/rename/binary.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# Exit the script as soon as an error occurs.
+set -e
+
+# On MacOS, ensure that GNU sed is installed and available as `gsed`.
+SED_COMMAND=sed
+if [[ "$OSTYPE" == "darwin"* ]]; then
+  if ! command -v gsed &> /dev/null; then
+      echo "Error: gsed is not installed. Please install it using 'brew install gnu-sed'."
+      exit 1
+  fi
+  SED_COMMAND=gsed
+fi
+
+# This script changes the binary name from `rippled` to `xrpld`, and creates a
+# symlink named `rippled` that points to the `xrpld` binary.
+# Usage: .github/scripts/rename/binary.sh <repository directory>
+
+if [ "$#" -ne 1 ]; then
+    echo "Usage: $0 <repository directory>"
+    exit 1
+fi
+
+DIRECTORY=$1
+echo "Processing directory: ${DIRECTORY}"
+if [ ! -d "${DIRECTORY}" ]; then
+    echo "Error: Directory '${DIRECTORY}' does not exist."
+    exit 1
+fi
+
+FILE="${DIRECTORY}/cmake/XrplCore.cmake"
+echo "Processing file: ${FILE}"
+${SED_COMMAND} -i -E 's/For the time being.+/Create a symlink named "rippled" for backward compatibility./g' "${FILE}"
+${SED_COMMAND} -i -E 's/set_target_properties\(xrpld.+/add_custom_command(TARGET xrpld POST_BUILD COMMAND ${CMAKE_COMMAND} -E create_symlink "xrpld" "rippled")/g' "${FILE}"
+
+echo "Processing complete."

.github/workflows/reusable-check-rename.yml

@@ -25,6 +25,8 @@ jobs:
         run: .github/scripts/rename/copyright.sh .
       - name: Check CMake configs
         run: .github/scripts/rename/cmake.sh .
+      - name: Check binary name
+        run: .github/scripts/rename/binary.sh .
       - name: Check for differences
         env:
           MESSAGE: |

cmake/XrplCore.cmake

@@ -226,6 +226,6 @@ if(xrpld)
       src/test/ledger/Invariants_test.cpp
       PROPERTIES SKIP_UNITY_BUILD_INCLUSION TRUE)
   endif()
-  # For the time being, we will keep the name of the binary as it was.
-  set_target_properties(xrpld PROPERTIES OUTPUT_NAME "rippled")
+  # Create a symlink named "rippled" for backward compatibility.
+  add_custom_command(TARGET xrpld POST_BUILD COMMAND ${CMAKE_COMMAND} -E create_symlink "xrpld" "rippled")
 endif()