From 05cb37d08a09430094cf6f651165b3e56ee4a84a Mon Sep 17 00:00:00 2001 From: Nitish Singh <93253740+nitishhsinghhh@users.noreply.github.com> Date: Sat, 30 May 2026 19:52:58 +0530 Subject: [PATCH] Standardize Infrastructure Headers Across Build and Orchestration Scripts --- .../Scripts/orchestrate-native-docker.sh | 78 ++++++++++------ .../CppLib/Scripts/orchestrate-native.sh | 86 ++++++++++++------ .../CppLib/Scripts/run-local-context.sh | 78 ++++++++++------ .../scripts/bootstrap-workspace.sh | 88 ++++++++++++++++--- .../scripts/orchestrate-service.sh | 74 ++++++++++++---- .../scripts/provision-telemetry.sh | 66 +++++++++++--- .../scripts/validate-interop.sh | 62 ++++++++++--- scripts/gh-automate.sh | 71 ++++++++++----- scripts/init-ui-workspace.sh | 60 ++++++++++--- 9 files changed, 489 insertions(+), 174 deletions(-) diff --git a/Backend/CaseConversionAPI/CppLib/Scripts/orchestrate-native-docker.sh b/Backend/CaseConversionAPI/CppLib/Scripts/orchestrate-native-docker.sh index fea0cd6..a4f2c16 100755 --- a/Backend/CaseConversionAPI/CppLib/Scripts/orchestrate-native-docker.sh +++ b/Backend/CaseConversionAPI/CppLib/Scripts/orchestrate-native-docker.sh @@ -1,36 +1,62 @@ #!/bin/bash +# SPDX-License-Identifier: Apache-2.0 #*********************************************************************/ -# Master Native Orchestrator: C++ Core (The Big Three) */ -# Version : 1.2 */ +# SYSTEM : CaseConversionAPI Infrastructure */ +# SUBSYSTEM : Native Processing Engine */ +# COMPONENT : orchestrate-native-docker */ +# VERSION : 1.3 */ # */ -# Purpose : Coordinates Local (macOS) and Dockerized (Linux/Win) */ -# builds to generate a unified multi-platform binary */ -# set. */ +# DESCRIPTION : Coordinates local and containerized native build */ +# pipelines to produce a unified cross-platform */ +# binary distribution for the C++ conversion engine. */ # */ -# Features : */ -# * Native macOS build + execution */ -# * Linux cross-build orchestration */ -# * Windows MinGW-w64 cross-compilation */ -# * Dockerized GoogleTest validation */ -# * Automated artifact extraction + synchronization */ +# Orchestrates native macOS compilation, Linux */ +# containerized validation, Windows cross-platform */ +# artifact extraction, and consolidated runtime */ +# synchronization for downstream consumers. */ # */ -# Location : Backend/CaseConversionAPI/CppLib/Scripts/ */ -# orchestrate-native-docker.sh */ +# FEATURES : */ +# * Native macOS build orchestration */ +# * Linux containerized compilation */ +# * Windows cross-platform artifact generation */ +# * Dockerized GoogleTest execution */ +# * Automated artifact extraction */ +# * Cross-platform binary synchronization */ +# * Unified distribution directory generation */ +# * Repository-aware path normalization */ # */ -# Revision History: */ -# ------------------------------------------------------------------ */ -# Version Date Author Description */ +# SIDE EFFECTS: Creates Docker images and containers on the host. */ +# Generates platform-specific shared libraries and */ +# modifies build output directories during artifact */ +# synchronization and cleanup operations. */ +# */ +# LOCATION : Backend/CaseConversionAPI/CppLib/Scripts/ */ +# orchestrate-native-docker.sh */ +# */ +# LICENSE : Apache License, Version 2.0 */ +# Licensed under the Apache License, Version 2.0. */ +# You may obtain a copy of the License at */ +# http://www.apache.org/licenses/LICENSE-2.0 */ +# */ +# AUTHOR : Nitish Singh (nitishhsinghhh) */ +# CONTACT : me.singhnitish@yandex.com */ +# */ +# REVISION HISTORY: */ # ------------------------------------------------------------------ */ -# 1.0 2026-05-14 Nitish Singh Initial Master Orchestrator*/ -# with Docker extraction. */ -# 1.1 2026-05-16 Nitish Singh Added backend root path */ -# normalization and improved */ -# Docker context handling. */ -# 1.2 2026-05-20 Nitish Singh Added containerized */ -# GoogleTest execution for */ -# Linux runtime validation */ -# and automated artifact */ -# synchronization pipeline. */ +# Ver Date Author Description */ +# --- ---------- -------------- -------------------------------- */ +# 1.0 2026-05-14 Nitish Singh Initial native orchestration */ +# workflow with Docker artifact */ +# extraction support. */ +# 1.1 2026-05-16 Nitish Singh Added backend root path */ +# normalization and improved */ +# Docker context handling. */ +# 1.2 2026-05-20 Nitish Singh Added containerized GoogleTest */ +# execution and automated binary */ +# synchronization pipeline. */ +# 1.3 2026-05-30 Nitish Singh Infrastructure header */ +# normalization and subsystem */ +# classification alignment. */ #*********************************************************************/ set -euo pipefail diff --git a/Backend/CaseConversionAPI/CppLib/Scripts/orchestrate-native.sh b/Backend/CaseConversionAPI/CppLib/Scripts/orchestrate-native.sh index b7b71e6..7fde2f9 100755 --- a/Backend/CaseConversionAPI/CppLib/Scripts/orchestrate-native.sh +++ b/Backend/CaseConversionAPI/CppLib/Scripts/orchestrate-native.sh @@ -1,38 +1,68 @@ #!/bin/bash +# SPDX-License-Identifier: Apache-2.0 #*********************************************************************/ -# Utility Script - C++ Core Orchestration (Monorepo) */ -# Version : 1.6 */ +# SYSTEM : CaseConversionAPI Infrastructure */ +# SUBSYSTEM : Native Processing Engine */ +# COMPONENT : orchestrate-native */ +# VERSION : 1.7 */ # */ -# Purpose : Configures, builds, and executes C++ logic & tests. */ +# DESCRIPTION : Configures, builds, validates, and executes the */ +# native C++ conversion engine across supported */ +# target environments. */ # */ -# Features : */ -# * Matrix OS orchestration */ -# * Dynamic build path synchronization */ -# * MinGW Windows cross-compilation */ -# * Apple Silicon optimization support */ -# * Automated GoogleTest execution */ -# * Parallelized multi-core compilation */ -# * Pre-build clang-format automation */ +# Orchestrates platform-specific build configuration, */ +# automated source formatting, parallel compilation, */ +# GoogleTest validation, and artifact generation for */ +# local and CI/CD execution pipelines. */ # */ -# Location : CppLib/Scripts/orchestrate-native.sh */ +# FEATURES : */ +# * Matrix OS orchestration */ +# * Dynamic build path synchronization */ +# * MinGW Windows cross-compilation */ +# * Microsoft Visual Studio integration */ +# * Apple Silicon optimization support */ +# * Automated GoogleTest execution */ +# * Parallelized multi-core compilation */ +# * Pre-build clang-format automation */ +# * Dynamic CMake generator selection */ +# * Repository-aware workspace validation */ # */ -# Revision History: */ -# ------------------------------------------------------------------ */ -# Version Date Author Description */ +# SIDE EFFECTS: Creates and modifies build output directories. */ +# Generates platform-specific binaries and test */ +# executables within the configured build tree. */ +# */ +# LOCATION : Backend/CaseConversionAPI/CppLib/Scripts/ */ +# orchestrate-native.sh */ +# */ +# LICENSE : Apache License, Version 2.0 */ +# Licensed under the Apache License, Version 2.0. */ +# You may obtain a copy of the License at */ +# http://www.apache.org/licenses/LICENSE-2.0 */ +# */ +# AUTHOR : Nitish Singh (nitishhsinghhh) */ +# CONTACT : me.singhnitish@yandex.com */ +# */ +# REVISION HISTORY: */ # ------------------------------------------------------------------ */ -# 1.0 2026-04-14 Nitish Singh Initial C++ Run Script */ -# 1.1 2026-04-15 Nitish Singh Updated for /backend path */ -# 1.2 2026-04-16 Nitish Singh Added Dynamic Path Sync */ -# 1.3 2026-05-02 Nitish Singh Added Matrix OS Support */ -# 1.4 2026-05-09 Nitish Singh Enhanced M2 P-Core detection*/ -# and script versioning. */ -# 1.5 2026-05-16 Nitish Singh Standardized logging, */ -# execution context validation*/ -# and dynamic path handling. */ -# 1.6 2026-05-28 Nitish Singh Added automated pre-build */ -# clang-format execution with */ -# controlled non-fatal */ -# formatting fallback logic. */ +# Ver Date Author Description */ +# --- ---------- -------------- -------------------------------- */ +# 1.0 2026-04-14 Nitish Singh Initial C++ orchestration */ +# script implementation. */ +# 1.1 2026-04-15 Nitish Singh Updated backend path */ +# synchronization logic. */ +# 1.2 2026-04-16 Nitish Singh Added dynamic workspace */ +# context resolution. */ +# 1.3 2026-05-02 Nitish Singh Added matrix OS orchestration */ +# support. */ +# 1.4 2026-05-09 Nitish Singh Enhanced Apple Silicon */ +# optimization and versioning. */ +# 1.5 2026-05-16 Nitish Singh Standardized logging and */ +# execution context validation. */ +# 1.6 2026-05-28 Nitish Singh Added automated clang-format */ +# integration and fallback logic. */ +# 1.7 2026-05-30 Nitish Singh Infrastructure header */ +# normalization and subsystem */ +# classification alignment. */ #*********************************************************************/ set -euo pipefail diff --git a/Backend/CaseConversionAPI/CppLib/Scripts/run-local-context.sh b/Backend/CaseConversionAPI/CppLib/Scripts/run-local-context.sh index 8efda95..6925361 100755 --- a/Backend/CaseConversionAPI/CppLib/Scripts/run-local-context.sh +++ b/Backend/CaseConversionAPI/CppLib/Scripts/run-local-context.sh @@ -1,36 +1,62 @@ #!/bin/bash +# SPDX-License-Identifier: Apache-2.0 #*********************************************************************/ -# Utility Script - Local CLI App Runner (macOS Optimized) */ -# Version : 1.4 */ +# SYSTEM : CaseConversionAPI Infrastructure */ +# SUBSYSTEM : Native Processing Engine */ +# COMPONENT : run-local */ +# VERSION : 1.5 */ # */ -# Purpose : Temporarily swaps CMakeLists to build/run the CLI app */ -# without modifying the main project architecture. */ +# DESCRIPTION : Builds and executes the standalone native CLI */ +# application without altering the primary library */ +# architecture or repository workflow. */ # */ -# Features : */ -# * Dynamic workspace synchronization */ -# * Safe CMakeLists backup/restore workflow */ -# * Apple Silicon (M-Series) optimization */ -# * Automated clang-format integration */ -# * Parallelized multi-core compilation */ -# * Execution context validation + cleanup */ +# Performs temporary build-context substitution, */ +# automated source formatting, optimized Apple */ +# Silicon compilation, and controlled restoration */ +# of the native project configuration. */ # */ -# Location : backend/CaseConversionAPI/CppLib/Scripts/run-local.sh */ +# FEATURES : */ +# * Dynamic workspace synchronization */ +# * Safe CMakeLists backup and restore workflow */ +# * Apple Silicon (M-Series) optimization */ +# * Automated clang-format integration */ +# * Parallelized multi-core compilation */ +# * Execution context validation */ +# * Automated cleanup and restoration */ +# * Standalone CLI application execution */ # */ -# Revision History: */ -# ------------------------------------------------------------------ */ -# Version Date Author Description */ +# SIDE EFFECTS: Temporarily replaces the active CMakeLists.txt */ +# configuration during execution. Generates build */ +# artifacts and modifies local build directories. */ +# */ +# LOCATION : Backend/CaseConversionAPI/CppLib/Scripts/ */ +# run-local.sh */ +# */ +# LICENSE : Apache License, Version 2.0 */ +# Licensed under the Apache License, Version 2.0. */ +# You may obtain a copy of the License at */ +# http://www.apache.org/licenses/LICENSE-2.0 */ +# */ +# AUTHOR : Nitish Singh (nitishhsinghhh) */ +# CONTACT : me.singhnitish@yandex.com */ +# */ +# REVISION HISTORY: */ # ------------------------------------------------------------------ */ -# 1.0 2026-04-16 Nitish Singh Initial Swap Logic Script */ -# 1.1 2026-04-16 Nitish Singh Added Absolute Path Trap */ -# 1.2 2026-05-09 Nitish Singh Optimized for M2 P-Cores */ -# and enhanced error cleanup. */ -# 1.3 2026-05-16 Nitish Singh Added execution context */ -# validation and dynamic path */ -# synchronization. */ -# 1.4 2026-05-28 Nitish Singh Added automated clang-format*/ -# execution with isolated */ -# non-fatal formatter */ -# fallback handling. */ +# Ver Date Author Description */ +# --- ---------- -------------- -------------------------------- */ +# 1.0 2026-04-16 Nitish Singh Initial local application */ +# runner implementation. */ +# 1.1 2026-04-16 Nitish Singh Added absolute path handling */ +# and restoration safeguards. */ +# 1.2 2026-05-09 Nitish Singh Added Apple Silicon */ +# optimizations and cleanup. */ +# 1.3 2026-05-16 Nitish Singh Added execution context */ +# validation and path sync. */ +# 1.4 2026-05-28 Nitish Singh Added automated clang-format */ +# execution and fallback logic. */ +# 1.5 2026-05-30 Nitish Singh Infrastructure header */ +# normalization and subsystem */ +# classification alignment. */ #*********************************************************************/ set -euo pipefail diff --git a/Backend/CaseConversionAPI/scripts/bootstrap-workspace.sh b/Backend/CaseConversionAPI/scripts/bootstrap-workspace.sh index 74afa2a..4b27adb 100755 --- a/Backend/CaseConversionAPI/scripts/bootstrap-workspace.sh +++ b/Backend/CaseConversionAPI/scripts/bootstrap-workspace.sh @@ -1,22 +1,58 @@ #!/bin/bash # SPDX-License-Identifier: Apache-2.0 #*********************************************************************/ -# Utility Script - Project Scaffolding (Microsoft-Style) */ -# Version : 1.3 */ +# SYSTEM : CaseConversionAPI Infrastructure */ +# SUBSYSTEM : Repository Bootstrap Framework */ +# COMPONENT : create_structure */ +# VERSION : 1.4 */ # */ -# Purpose : Generates the monorepo hierarchy for C++ and .NET. */ -# Location : scripts/create_structure.sh */ +# DESCRIPTION : Generates the foundational monorepo directory */ +# hierarchy for the CaseConversionAPI platform. */ +# Initializes native C++ components, .NET API */ +# layers, test infrastructure, automation scripts, */ +# and repository-level configuration assets. */ # */ -# Revision History: */ -# ------------------------------------------------------------------ */ -# Version Date Author Description */ +# FEATURES : */ +# * Native C++ project scaffolding */ +# * .NET API workspace initialization */ +# * Test framework directory generation */ +# * Infrastructure and automation layout creation */ +# * Root configuration and documentation setup */ +# * Monorepo architecture standardization */ +# */ +# SIDE EFFECTS: Creates directories, generates boilerplate source */ +# files, initializes repository configuration assets, */ +# and copies automation scripts into the workspace. */ +# */ +# LICENSE : Apache License, Version 2.0 */ +# Licensed under the Apache License, Version 2.0. */ +# You may obtain a copy of the License at */ +# http://www.apache.org/licenses/LICENSE-2.0 */ +# */ +# AUTHOR : Nitish Singh (nitishhsinghhh) */ +# CONTACT : me.singhnitish@yandex.com */ +# */ +# DEPENDENCIES: */ +# * Bash */ +# * mkdir */ +# * cp */ +# * cat */ +# * touch */ +# */ +# LOCATION : scripts/create_structure.sh */ +# */ +# REVISION HISTORY: */ # ------------------------------------------------------------------ */ -# 1.0 2026-04-14 Nitish Singh Initial Structure Template */ -# 1.1 2026-04-16 Nitish Singh Added Version Header */ -# 1.2 2026-05-09 Nitish Singh Explicit versioning and */ -# M2 project alignment. */ -# 1.3 2026-05-09 Nitish Singh Standardized logging, */ -# automated headers & cleanup.*/ +# Ver Date Author Description */ +# --- ---------- -------------- -------------------------------- */ +# 1.0 2026-04-14 Nitish Singh Initial Structure Template */ +# 1.1 2026-04-16 Nitish Singh Added Version Header */ +# 1.2 2026-05-09 Nitish Singh Added M2 Alignment and */ +# Explicit Versioning */ +# 1.3 2026-05-09 Nitish Singh Standardized Logging, Headers, */ +# and Cleanup Logic */ +# 1.4 2026-05-30 Nitish Singh Refactored to Infrastructure */ +# Metadata Standard */ #*********************************************************************/ set -euo pipefail @@ -35,6 +71,32 @@ timestamp() { date +"%Y-%m-%d %H:%M:%S"; } log_info() { echo -e "${BLUE}[$(timestamp)] [INFO]${NC} $1"; } log_success() { echo -e "${GREEN}[$(timestamp)] [SUCCESS]${NC} $1"; } +#*********************************************************************/ +# Dependency Validation */ +#*********************************************************************/ + +check_dependency() { + local cmd="$1" + + if ! command -v "$cmd" >/dev/null 2>&1; then + log_error "Missing dependency: $cmd" + + case "$cmd" in + dotnet) + echo "Install .NET SDK: https://dotnet.microsoft.com/download" + ;; + cmake) + echo "Install CMake: https://cmake.org/download/" + ;; + git) + echo "Install Git: https://git-scm.com/downloads" + ;; + esac + + exit 1 + fi +} + #*********************************************************************/ # 1. Root Initialization */ #*********************************************************************/ diff --git a/Backend/CaseConversionAPI/scripts/orchestrate-service.sh b/Backend/CaseConversionAPI/scripts/orchestrate-service.sh index aa6d359..3287837 100755 --- a/Backend/CaseConversionAPI/scripts/orchestrate-service.sh +++ b/Backend/CaseConversionAPI/scripts/orchestrate-service.sh @@ -1,27 +1,65 @@ #!/bin/bash # SPDX-License-Identifier: Apache-2.0 #*********************************************************************/ -# Utility Script - .NET API Orchestration (Monorepo) */ -# Version : 1.7 */ +# SYSTEM : CaseConversionAPI Infrastructure */ +# SUBSYSTEM : Managed API Runtime Layer (.NET 8) */ +# COMPONENT : run-dotnet */ +# VERSION : 1.8 */ # */ -# Purpose : Manages the lifecycle (Restore, Build, Publish, Run) */ -# of the .NET 8 REST API within the monorepo context. */ -# Location : backend/CaseConversionAPI/Scripts/run-dotnet.sh */ +# DESCRIPTION : Orchestrates the complete lifecycle of the managed */ +# API gateway, including dependency restoration, */ +# compilation, native runtime synchronization, */ +# publication, and local execution. */ # */ -# Revision History: */ -# ------------------------------------------------------------------ */ -# Version Date Author Description */ +# Ensures ABI compatibility between the native C++ */ +# conversion engine and the .NET P/Invoke layer by */ +# automatically resolving and injecting platform- */ +# specific shared libraries into the runtime context. */ +# */ +# FEATURES : */ +# * Automated dependency restoration */ +# * Release-mode compilation */ +# * Native library discovery and synchronization */ +# * Dynamic platform detection */ +# * Publish artifact generation */ +# * Runtime environment preparation */ +# * Local API hosting and execution */ +# */ +# SIDE EFFECTS: Terminates active listeners on port 5000. */ +# Creates publish artifacts and synchronizes native */ +# runtime binaries into execution directories. */ +# */ +# LICENSE : Apache License, Version 2.0 */ +# Licensed under the Apache License, Version 2.0. */ +# You may obtain a copy of the License at */ +# http://www.apache.org/licenses/LICENSE-2.0 */ +# */ +# AUTHOR : Nitish Singh (nitishhsinghhh) */ +# CONTACT : me.singhnitish@yandex.com */ +# */ +# REVISION HISTORY: */ # ------------------------------------------------------------------ */ -# 1.0 2026-04-14 Nitish Singh Initial .NET build script */ -# 1.1 2026-04-15 Nitish Singh Added Dynamic Path Logic */ -# 1.2 2026-04-16 Nitish Singh Refactored exit/root logic */ -# 1.3 2026-04-16 Nitish Singh Added Native Dylib Sync */ -# 1.4 2026-04-16 Nitish Singh Fixed naming prefix mismatch*/ -# 1.5 2026-04-16 Nitish Singh Added Port Cleanup logic */ -# 1.6 2026-05-09 Nitish Singh Added M2 P-Core DYLD path */ -# export and versioning. */ -# 1.7 2026-05-09 Nitish Singh Standardized logging, */ -# cross-platform lib sync. */ +# Ver Date Author Description */ +# --- ---------- -------------- -------------------------------- */ +# 1.0 2026-04-14 Nitish Singh Initial .NET orchestration */ +# workflow. */ +# 1.1 2026-04-15 Nitish Singh Added dynamic repository path */ +# resolution. */ +# 1.2 2026-04-16 Nitish Singh Refactored execution flow and */ +# root context handling. */ +# 1.3 2026-04-16 Nitish Singh Added native library sync */ +# automation. */ +# 1.4 2026-04-16 Nitish Singh Standardized native binary */ +# naming conventions. */ +# 1.5 2026-04-16 Nitish Singh Added port cleanup and runtime */ +# recovery logic. */ +# 1.6 2026-05-09 Nitish Singh Added macOS dynamic linker */ +# environment support. */ +# 1.7 2026-05-09 Nitish Singh Standardized structured logging */ +# and cross-platform library sync. */ +# 1.8 2026-05-30 Nitish Singh Enterprise header normalization, */ +# infrastructure metadata, and */ +# lifecycle documentation. */ #*********************************************************************/ set -euo pipefail diff --git a/Backend/CaseConversionAPI/scripts/provision-telemetry.sh b/Backend/CaseConversionAPI/scripts/provision-telemetry.sh index 3333790..3c1bfd3 100755 --- a/Backend/CaseConversionAPI/scripts/provision-telemetry.sh +++ b/Backend/CaseConversionAPI/scripts/provision-telemetry.sh @@ -1,23 +1,61 @@ #!/bin/bash # SPDX-License-Identifier: Apache-2.0 #*********************************************************************/ -# Utility Script - Telemetry Infrastructure (Jaeger/OTLP) */ -# Version : 1.2 */ +# SYSTEM : CaseConversionAPI Infrastructure */ +# SUBSYSTEM : Observability & Distributed Tracing */ +# COMPONENT : provision-telemetry */ +# VERSION : 1.3 */ # */ -# Purpose : Manages the lifecycle of the Jaeger container for */ -# OpenTelemetry trace collection and visualization. */ -# Usage : backend/CaseConversionAPI/Scripts/provision-telemetry.sh -# [start|stop|status] */ +# DESCRIPTION : Provisions and manages the local telemetry stack */ +# using Jaeger All-In-One for OpenTelemetry trace */ +# ingestion, storage, and visualization. */ # */ -# Revision History: */ -# ------------------------------------------------------------------ */ -# Version Date Author Description */ +# Provides lifecycle management for containerized */ +# tracing infrastructure used during development, */ +# integration testing, and platform diagnostics. */ +# */ +# FEATURES : */ +# * Automated Jaeger container provisioning */ +# * OTLP gRPC endpoint exposure (4317) */ +# * OTLP HTTP endpoint exposure (4318) */ +# * Trace visualization via Jaeger UI */ +# * Container lifecycle management */ +# * Runtime status inspection */ +# * Live telemetry log streaming */ +# */ +# SIDE EFFECTS: Creates and manages Docker containers on the host. */ +# Binds local telemetry ports and persists runtime */ +# state through Docker-managed resources. */ +# */ +# USAGE : backend/CaseConversionAPI/Scripts/ */ +# provision-telemetry.sh */ +# */ +# Commands: */ +# start - Provision or start Jaeger */ +# stop - Stop active telemetry services */ +# status - Display container runtime status */ +# logs - Follow Jaeger container logs */ +# */ +# LICENSE : Apache License, Version 2.0 */ +# Licensed under the Apache License, Version 2.0. */ +# You may obtain a copy of the License at */ +# http://www.apache.org/licenses/LICENSE-2.0 */ +# */ +# AUTHOR : Nitish Singh (nitishhsinghhh) */ +# CONTACT : me.singhnitish@yandex.com */ +# */ +# REVISION HISTORY: */ # ------------------------------------------------------------------ */ -# 1.0 2026-04-18 Nitish Singh Initial implementation. */ -# 1.1 2026-05-09 Nitish Singh Added explicit version */ -# tag to header. */ -# 1.2 2026-05-09 Nitish Singh Standardized log, */ -# added log follow cmd. */ +# Ver Date Author Description */ +# --- ---------- -------------- -------------------------------- */ +# 1.0 2026-04-18 Nitish Singh Initial telemetry provisioning */ +# implementation. */ +# 1.1 2026-05-09 Nitish Singh Added explicit version metadata. */ +# 1.2 2026-05-09 Nitish Singh Standardized logging and added */ +# live container log streaming. */ +# 1.3 2026-05-30 Nitish Singh Infrastructure header */ +# normalization and observability */ +# subsystem classification. */ #*********************************************************************/ set -euo pipefail diff --git a/Backend/CaseConversionAPI/scripts/validate-interop.sh b/Backend/CaseConversionAPI/scripts/validate-interop.sh index c5ad9cf..44f8c2b 100755 --- a/Backend/CaseConversionAPI/scripts/validate-interop.sh +++ b/Backend/CaseConversionAPI/scripts/validate-interop.sh @@ -1,22 +1,58 @@ #!/bin/bash # SPDX-License-Identifier: Apache-2.0 #*********************************************************************/ -# Utility Script - .NET Test Orchestration (Monorepo) */ -# Version : 1.2 */ +# SYSTEM : CaseConversionAPI Infrastructure */ +# SUBSYSTEM : Managed API Quality Assurance Layer */ +# COMPONENT : run-tests */ +# VERSION : 1.4 */ # */ -# Purpose : Executes the .NET 8 Test Suite from the scripts folder.*/ -# Usage : ./run-tests.sh */ +# DESCRIPTION : Orchestrates execution of the .NET integration and */ +# unit testing suite within the monorepo ecosystem. */ # */ -# Revision History: */ -# ------------------------------------------------------------------ */ -# Version Date Author Description */ +# Automatically discovers, synchronizes, and injects */ +# platform-specific native binaries required by the */ +# P/Invoke interoperability layer before executing */ +# managed test workloads. */ +# */ +# FEATURES : */ +# * Automated workspace synchronization */ +# * Cross-platform native library discovery */ +# * Dynamic runtime path configuration */ +# * Native ABI validation */ +# * .NET Release-mode test execution */ +# * Platform-aware dependency injection */ +# * Monorepo-relative path resolution */ +# */ +# SIDE EFFECTS: Copies native runtime libraries into the test */ +# execution directory and exports dynamic linker */ +# search paths for the current shell session. */ +# */ +# USAGE : backend/CaseConversionAPI/Scripts/run-tests.sh */ +# */ +# LICENSE : Apache License, Version 2.0 */ +# Licensed under the Apache License, Version 2.0. */ +# You may obtain a copy of the License at */ +# http://www.apache.org/licenses/LICENSE-2.0 */ +# */ +# AUTHOR : Nitish Singh (nitishhsinghhh) */ +# CONTACT : me.singhnitish@yandex.com */ +# */ +# REVISION HISTORY: */ # ------------------------------------------------------------------ */ -# 1.0 2026-04-16 Nitish Singh Initial Test Script */ -# 1.1 2026-04-30 Nitish Singh Added Native Library Sync */ -# 1.2 2026-05-09 Nitish Singh Enhanced DYLD path resolution -# and M2 architecture checks. */ -# 1.3 2026-05-09 Nitish Singh Standardized logging, */ -# cross-platform lib sync. */ +# Ver Date Author Description */ +# --- ---------- -------------- -------------------------------- */ +# 1.0 2026-04-16 Nitish Singh Initial .NET test orchestration */ +# implementation. */ +# 1.1 2026-04-30 Nitish Singh Added native library runtime */ +# synchronization. */ +# 1.2 2026-05-09 Nitish Singh Enhanced dynamic linker path */ +# resolution and architecture */ +# validation support. */ +# 1.3 2026-05-09 Nitish Singh Standardized logging and */ +# cross-platform native sync. */ +# 1.4 2026-05-30 Nitish Singh Infrastructure header */ +# normalization and QA subsystem */ +# classification. */ #*********************************************************************/ set -euo pipefail diff --git a/scripts/gh-automate.sh b/scripts/gh-automate.sh index 7cf4f74..2dcac4b 100755 --- a/scripts/gh-automate.sh +++ b/scripts/gh-automate.sh @@ -1,31 +1,56 @@ #!/bin/bash -# SPDX-License-Identifier: Apache-2.0 #*********************************************************************/ -# File : gh-automate.sh */ -# Version : 1.7 */ +# SYSTEM : GitHub Workflow Automation Framework */ +# SUBSYSTEM : Pull Request Lifecycle Orchestrator */ +# COMPONENT : gh-automate */ +# VERSION : 1.8 */ # */ -# Purpose : Local PR Automator for standardization and cleanup. */ -# Handles branch creation, PR submission, and merging. */ +# DESCRIPTION : Automates Git branch lifecycle management and */ +# GitHub Pull Request operations. Performs branch */ +# preparation, commit orchestration, remote sync, */ +# PR creation, CI/CD monitoring, merge execution, */ +# and local repository synchronization. */ # */ -# Revision History: */ -# ------------------------------------------------------------------ */ -# Version Date Author Description */ +# FEATURES : */ +# * Branch creation and checkout */ +# * Automated staging and commit management */ +# * Remote synchronization with lease protection */ +# * GitHub Pull Request creation and tracking */ +# * Live CI/CD monitoring via GitHub CLI */ +# * Administrative squash merge support */ +# * Automatic local main branch synchronization */ +# */ +# SIDE EFFECTS: Pushes commits to remote repositories, creates */ +# GitHub Pull Requests, merges approved changes, */ +# deletes merged branches, and updates local state. */ +# */ +# LICENSE : Apache License, Version 2.0 */ +# Licensed under the Apache License, Version 2.0. */ +# You may obtain a copy of the License at */ +# http://www.apache.org/licenses/LICENSE-2.0 */ +# */ +# AUTHOR : Nitish Singh (nitishhsinghhh) */ +# CONTACT : me.singhnitish@yandex.com */ +# */ +# DEPENDENCIES: */ +# * Git */ +# * GitHub CLI (gh) */ +# * GitHub Authentication Session */ +# */ +# REVISION HISTORY: */ # ------------------------------------------------------------------ */ -# 1.0 2026-04-14 Nitish Singh Initial Automation Script. */ -# 1.1 2026-05-09 Nitish Singh Added architecture sync and */ -# M2 cleanup verification. */ -# 1.2 2026-05-09 Nitish Singh Refined manual checkpoint */ -# and added final sync steps. */ -# 1.3 2026-05-09 Nitish Singh Open PR in browser for CI */ -# monitoring */ -# 1.4 2026-05-09 Nitish Singh Added local GitHub checks */ -# monitoring via gh CLI. */ -# 1.5 2026-05-09 Nitish Singh Added structured logging, */ -# timestamps, and colors. */ -# 1.6 2026-05-09 Nitish Singh Added dependency and */ -# authentication validation. */ -# 1.7 2026-05-21 Nitish Singh Added pre-flight fetch sync */ -# and robust API 502 handling.*/ +# Ver Date Author Description */ +# --- ---------- -------------- -------------------------------- */ +# 1.0 2026-04-14 Nitish Singh Initial Automation Workflow */ +# 1.1 2026-05-09 Nitish Singh Added Architecture Sync Checks */ +# 1.2 2026-05-09 Nitish Singh Added Manual Approval Gate */ +# 1.3 2026-05-09 Nitish Singh Added Browser PR Monitoring */ +# 1.4 2026-05-09 Nitish Singh Added GitHub Checks Tracking */ +# 1.5 2026-05-09 Nitish Singh Added Structured Logging */ +# 1.6 2026-05-09 Nitish Singh Added Auth & Dependency Checks */ +# 1.7 2026-05-21 Nitish Singh Added Retry & API Resilience */ +# 1.8 2026-05-30 Nitish Singh Standardized Header Format and */ +# Lifecycle Documentation */ #*********************************************************************/ set -euo pipefail diff --git a/scripts/init-ui-workspace.sh b/scripts/init-ui-workspace.sh index 7590532..ebd0c43 100755 --- a/scripts/init-ui-workspace.sh +++ b/scripts/init-ui-workspace.sh @@ -1,22 +1,56 @@ #!/bin/bash # SPDX-License-Identifier: Apache-2.0 #*********************************************************************/ -# Utility Script - Frontend Scaffolding (Vite/TypeScript) */ -# Version : 1.2 */ +# SYSTEM : CaseConversionAPI Frontend Infrastructure */ +# SUBSYSTEM : UI Workspace Bootstrap Framework */ +# COMPONENT : scaffold-frontend */ +# VERSION : 1.3 */ # */ -# Purpose : Generates the directory hierarchy and boilerplate for */ -# the Vite-based TypeScript frontend application. */ -# Location : scripts/scaffold-frontend.sh */ +# DESCRIPTION : Generates a standardized Vite + TypeScript frontend */ +# workspace for the CaseConversionAPI platform. */ +# Creates directory hierarchy, boilerplate source */ +# files, styling assets, and development tooling */ +# configuration required for frontend initialization. */ # */ -# Revision History: */ -# ------------------------------------------------------------------ */ -# Version Date Author Description */ +# FEATURES : */ +# * Vite-based project scaffolding */ +# * TypeScript model generation */ +# * API client structure initialization */ +# * Stylesheet and asset provisioning */ +# * Node.js package configuration */ +# * Frontend architecture standardization */ +# */ +# SIDE EFFECTS: Creates project directories, generates source files, */ +# overwrites scaffolded boilerplate assets, and */ +# initializes frontend development configuration. */ +# */ +# LICENSE : Apache License, Version 2.0 */ +# Licensed under the Apache License, Version 2.0. */ +# You may obtain a copy of the License at */ +# http://www.apache.org/licenses/LICENSE-2.0 */ +# */ +# AUTHOR : Nitish Singh (nitishhsinghhh) */ +# CONTACT : me.singhnitish@yandex.com */ +# */ +# DEPENDENCIES: */ +# * Bash */ +# * Node.js */ +# * npm */ +# * Vite (post-install) */ +# * TypeScript (post-install) */ +# */ +# LOCATION : scripts/scaffold-frontend.sh */ +# */ +# REVISION HISTORY: */ # ------------------------------------------------------------------ */ -# 1.0 2026-04-28 Nitish Singh Initial UI Template */ -# 1.1 2026-05-09 Nitish Singh Added explicit versioning */ -# to match monorepo style. */ -# 1.2 2026-05-09 Nitish Singh Standardized logging, */ -# boilerplate injection. */ +# Ver Date Author Description */ +# --- ---------- -------------- -------------------------------- */ +# 1.0 2026-04-28 Nitish Singh Initial UI Template */ +# 1.1 2026-05-09 Nitish Singh Added Explicit Versioning */ +# 1.2 2026-05-09 Nitish Singh Standardized Logging and */ +# Boilerplate Injection */ +# 1.3 2026-05-30 Nitish Singh Refactored Header Structure and */ +# Infrastructure Metadata */ #*********************************************************************/ set -euo pipefail