Skip to content

refactor/beta prep for release#11

Merged
minademian merged 25 commits into
mainfrom
refactor/beta-prep-for-release
Nov 2, 2025
Merged

refactor/beta prep for release#11
minademian merged 25 commits into
mainfrom
refactor/beta-prep-for-release

Conversation

@minademian
Copy link
Copy Markdown
Owner

@minademian minademian commented Nov 2, 2025

A lot of cleanup, bug fixes, and refactoring

This pull request introduces several improvements to the project’s structure and documentation, with a focus on standardizing Makefile usage across utilities, enhancing documentation clarity, and cleaning up unused code. The most important changes are grouped below.

Makefile and Build System Standardization:

  • Introduced a new Makefile.common file containing shared test, unit test, integration test, and test-watch targets for all utilities, and updated the root Makefile to include this shared file and remove redundant target implementations. This centralizes build and test logic, reducing duplication. [1] [2] [3]
  • Updated the diff-check/Makefile to include Makefile.common and fixed test watcher paths to use the correct relative location for shared scripts, ensuring consistency and reliability of test commands. [1] [2]

Documentation and Roadmap Improvements:

  • Refined the main README.md to clarify section headings, improve project documentation links, and ensure consistency in project information and contribution guidelines. [1] [2] [3] [4] [5] [6] [7] [8]
  • Overhauled ROADMAP.md to provide a clear summary of current status and upcoming milestones, replacing the previous long-term roadmap with a more actionable and concise release plan for the next versions.
  • Updated the diff-check/README.md to reflect the new version number and last updated date, keeping project metadata current. [1] [2]

Codebase Cleanup:

  • Removed the unused diff-check/lib/diff_helpers.sh file, eliminating dead code and reducing maintenance overhead.

These changes collectively improve maintainability, developer experience, and project clarity.

@minademian minademian requested a review from Copilot November 2, 2025 15:51
@minademian minademian self-assigned this Nov 2, 2025
@minademian minademian added bug Something isn't working release-candidate labels Nov 2, 2025
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request represents a major refactoring and consolidation effort to prepare for the v1.0.0-rc.1 release. The key changes include:

  • Refactored code organization by extracting shared logging functionality into a central lib/logging.sh library
  • Standardized color variable naming from NC to NO_COLOR across all scripts for consistency
  • Reorganized diff-check functionality by splitting monolithic helper files into focused modules (git.sh, output.sh, reports.sh, fs.sh)
  • Added new shared library testing infrastructure with watch capability
  • Updated version numbers and documentation to reflect rc.1 status

Reviewed Changes

Copilot reviewed 25 out of 27 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
tests/watch.sh Enhanced with shared library test support and centralized logging
tests/lib/test_logging.sh New comprehensive test suite for shared logging library
lib/logging.sh New shared logging library consolidating color definitions and logging functions
lib/output.sh Empty placeholder for future shared output functionality
diff-check/diff-check.sh Major refactoring to use modular libraries and improved error handling
diff-check/lib/*.sh New modular library files splitting functionality from diff_helpers.sh
server-audit/tests/*.sh Updated to use NO_COLOR constant for consistency
server-audit/README.md Version bump to rc.1
Makefile* Added shared library testing targets and consolidated common targets
ROADMAP.md Simplified and focused on near-term milestones
README.md Formatting and structure improvements
Comments suppressed due to low confidence (1)

tests/watch.sh:11

  • SCRIPT_DIR is defined twice (lines 8 and 11) with identical logic. Remove the duplicate on line 11 as it's redundant and could cause confusion.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread diff-check/lib/output.sh Outdated
Comment thread diff-check/diff-check.sh Outdated
Comment thread diff-check/diff-check.sh
Comment thread lib/logging.sh Outdated
Comment thread diff-check/lib/reports.sh Outdated
Comment thread diff-check/lib/git.sh Outdated
Comment thread diff-check/lib/git.sh Outdated
Comment thread diff-check/lib/reports.sh Outdated
minademian and others added 8 commits November 2, 2025 17:06
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…:minademian/server-utilities into refactor/beta-prep-for-release
@minademian minademian merged commit 362e8d2 into main Nov 2, 2025
1 check passed
@minademian minademian deleted the refactor/beta-prep-for-release branch November 2, 2025 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working release-candidate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants