refactor/beta prep for release#11
Merged
Merged
Conversation
There was a problem hiding this comment.
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.shlibrary - Standardized color variable naming from
NCtoNO_COLORacross 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.
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Makefile.commonfile containing shared test, unit test, integration test, and test-watch targets for all utilities, and updated the rootMakefileto include this shared file and remove redundant target implementations. This centralizes build and test logic, reducing duplication. [1] [2] [3]diff-check/Makefileto includeMakefile.commonand 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:
README.mdto clarify section headings, improve project documentation links, and ensure consistency in project information and contribution guidelines. [1] [2] [3] [4] [5] [6] [7] [8]ROADMAP.mdto 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.diff-check/README.mdto reflect the new version number and last updated date, keeping project metadata current. [1] [2]Codebase Cleanup:
diff-check/lib/diff_helpers.shfile, eliminating dead code and reducing maintenance overhead.These changes collectively improve maintainability, developer experience, and project clarity.