Skip to content

feat: implement Klipper repository migration to RatOS fork #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
miklschmidt wants to merge 45 commits into
base: development
Choose a base branch
from
Open

feat: implement Klipper repository migration to RatOS fork #92

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
82b9f8a
feat: implement Klipper repository migration to RatOS fork
miklschmidt Jun 21, 2025
9fdf7eb
fix: address CodeRabbit AI feedback and ShellCheck warnings
miklschmidt Jun 21, 2025
0ee8fc4
revert: roll back exponential backoff implementation
miklschmidt Jun 21, 2025
79c5978
feat: implement exit code capture and display for better debugging
miklschmidt Jun 21, 2025
94a6bfd
fix: add ShellCheck disable directive for sourced file
miklschmidt Jun 21, 2025
2366f9b
feat: add strict error handling with set -euo pipefail
miklschmidt Jun 21, 2025
3aa2a21
feat(klipper-migration): integrate with unified logging system
miklschmidt Jun 22, 2025
a13c0c5
feat(ratos-update): update klipper migration integration with unified…
miklschmidt Jun 22, 2025
19d24eb
docs(logging): add Klipper migration error codes to unified logging s…
miklschmidt Jun 22, 2025
873c05a
test(logging): update mock data with Klipper migration error codes
miklschmidt Jun 22, 2025
a08bcbc
fix(klipper-migration): standardize error code naming consistency
miklschmidt Jun 22, 2025
8cda3cf
feat(klipper-migration): enhance constants section with validation an…
miklschmidt Jun 22, 2025
e2be0e3
refactor(klipper-migration): optimize uncommitted changes detection w…
miklschmidt Jun 22, 2025
9718010
feat(klipper-migration): add automatic cleanup for temporary migratio…
miklschmidt Jun 22, 2025
9505fab
docs(logging): remove trailing punctuation from headings for MD026 co…
miklschmidt Jun 22, 2025
afe811c
fix(klipper): implement temp branch cleanup in checkout function
miklschmidt Jun 22, 2025
ed5b4f1
fix(klipper): update shebang to use portable env bash
miklschmidt Jun 22, 2025
0dd355d
fix(klipper): standardize error handling for root user check
miklschmidt Jun 22, 2025
8a6a394
feat(klipper): enhance environment variable validation robustness
miklschmidt Jun 22, 2025
33e8a67
refactor(klipper): optimize uncommitted changes detection with Git pl…
miklschmidt Jun 22, 2025
c96cb9c
perf(klipper): optimize remote management logic for better performance
miklschmidt Jun 22, 2025
39b2431
docs(logging): add new error codes for enhanced validation
miklschmidt Jun 22, 2025
c79bdb9
docs(klipper): add comprehensive documentation for migrate_klipper_re…
miklschmidt Jun 22, 2025
f0a85f8
chore(ai): add guidelines for processing task lists
miklschmidt Jun 22, 2025
178fe6f
fix(klipper): fix temporary branch cleanup trap mechanism in checkout…
miklschmidt Jun 22, 2025
71f767a
fix(cli): use /usr/bin/env bash instead of /bin/bash
miklschmidt Jun 22, 2025
84a65a2
ci: Add bash script syntax check to CI
miklschmidt Jun 22, 2025
3068cbd
feat(klipper): enhance temporary branch cleanup with function-level E…
miklschmidt Jun 22, 2025
96ea2b9
feat(klipper): enhance URL detection and error code differentiation
miklschmidt Jun 22, 2025
e9b1950
fix(ci): improve node_modules exclusion pattern in bash script valida…
miklschmidt Jun 22, 2025
f0024d6
fix(ci): correct grep usage with find -print0 to eliminate duplicate …
miklschmidt Jun 22, 2025
cc4f7d8
feat(ci): improve robustness when no bash scripts are found
miklschmidt Jun 22, 2025
70623c5
feat(ci): optimize shell script validation with parallel processing
miklschmidt Jun 22, 2025
39e1997
ci: Improve .git directory exclusion in bash linter
miklschmidt Jun 22, 2025
d60c201
ci: Refine detection of extensionless bash scripts
miklschmidt Jun 22, 2025
b921b93
feat(klipper): improve portability of path resolution with command fa…
miklschmidt Jun 22, 2025
0ccde04
refactor(klipper): optimize git command execution by eliminating dire…
miklschmidt Jun 22, 2025
3ffe6cc
feat(klipper): enhance repository state validation with comprehensive…
miklschmidt Jun 22, 2025
936b35e
feat(klipper): enhance script portability, maintainability, and corre…
miklschmidt Jun 22, 2025
a35ca1b
refactor(update): eliminate redundant repository validation in ensure…
miklschmidt Jun 22, 2025
cd8ebe0
feat(scripts): extract bash validation logic into standalone reusable…
miklschmidt Jun 22, 2025
e6e23c3
fix(scripts): resolve shellcheck SC2317 warnings in validate-bash-syn…
miklschmidt Jun 22, 2025
c95a8bc
feat(scripts): organize parallel validation output to eliminate inter…
miklschmidt Jun 22, 2025
84b7d8e
feat(scripts): add real-time feedback to parallel bash validation
miklschmidt Jun 22, 2025
e6550f4
feat(klipper): dynamically extract target commit from moonraker.conf
miklschmidt Jun 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions LOGGING_SYSTEM.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,11 +180,41 @@ Standardized error codes help identify common issues:
- `EXTENSION_SYMLINK_FAILED`: Extension symlinking failed
- `OWNERSHIP_CHANGE_FAILED`: File ownership change failed

### Klipper Migration Error Codes:
- `KLIPPER_DIR_NOT_FOUND`: Klipper directory not found
- `KLIPPER_NOT_GIT_REPO`: Klipper directory is not a git repository
- `KLIPPER_DIR_ACCESS_FAILED`: Cannot access Klipper directory
- `KLIPPER_STAGED_CHANGES`: Uncommitted staged changes prevent migration
- `KLIPPER_UNCOMMITTED_CHANGES`: Uncommitted changes prevent migration
- `KLIPPER_MIGRATION_FAILED`: General Klipper migration failure
- `GIT_REMOTE_URL_FAILED`: Failed to get git remote URL
- `GIT_REMOTE_ADD_FAILED`: Failed to add git remote
- `GIT_REMOTE_UPDATE_FAILED`: Failed to update git remote URL
- `GIT_FETCH_FAILED`: Failed to fetch from remote repository
- `GIT_FETCH_RETRY`: Fetch retry attempt
- `GIT_CHECKOUT_FAILED`: Failed to checkout branch
- `GIT_CHECKOUT_REMOTE_FAILED`: Failed to checkout remote branch
- `GIT_TEMP_BRANCH_FAILED`: Failed to create temporary branch
- `GIT_TEMP_BRANCH_CLEANUP`: Temporary branch cleanup operation
- `GIT_TEMP_BRANCH_CLEANUP_FAILED`: Failed to clean up temporary branch
- `GIT_COMMIT_NOT_FOUND`: Target commit not found
- `GIT_RESET_FAILED`: Failed to reset to target commit
- `GIT_UPSTREAM_SET_FAILED`: Failed to set upstream tracking
- `REMOTE_URL_MISMATCH`: Remote URL doesn't match expected value
- `REPOSITORY_CHECK_FAILED`: Repository check failed
- `REMOTE_SETUP_FAILED`: Remote setup failed
- `FETCH_FAILED`: Fetch operation failed
- `CHECKOUT_FAILED`: Checkout operation failed
- `RESET_FAILED`: Reset operation failed
- `OWNERSHIP_FAILED`: Ownership fix failed

Comment on lines 189 to 210
Copy link
Contributor

@coderabbitai coderabbitai bot Jun 22, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue

Align error code naming between script and documentation

The docs list both KLIPPER_MIGRATION_FAILED and MIGRATION_FAILED, but the migration script only emits MIGRATION_FAILED in the final error log. Standardize on one code—preferably KLIPPER_MIGRATION_FAILED to match other Klipper-specific codes—and update the script or documentation accordingly.

🤖 Prompt for AI Agents 
In LOGGING_SYSTEM.md between lines 189 and 209, the error codes list includes
both KLIPPER_MIGRATION_FAILED and MIGRATION_FAILED, but the migration script
only emits MIGRATION_FAILED. To fix this, standardize the error code naming by
choosing KLIPPER_MIGRATION_FAILED for consistency with other Klipper-specific
codes, then update either the documentation to remove MIGRATION_FAILED or modify
the migration script to emit KLIPPER_MIGRATION_FAILED instead, ensuring both are
aligned.

Copy link
Contributor

@coderabbitai coderabbitai bot Jun 22, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue

Document the MIGRATION_FAILED error code

The migration script emits MIGRATION_FAILED on final failure (log_error … "main" "MIGRATION_FAILED"), but this code isn't listed under “Klipper Migration Error Codes”. Add MIGRATION_FAILED to keep docs in sync with script behavior.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

183-183: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

🤖 Prompt for AI Agents 
In LOGGING_SYSTEM.md between lines 183 and 210, the error code MIGRATION_FAILED
is missing from the Klipper Migration Error Codes list. Add MIGRATION_FAILED to
this list to ensure the documentation matches the migration script's actual
error codes.

### System Error Codes:
- `FILE_NOT_FOUND`: Required file not found
- `PERMISSION_DENIED`: Insufficient permissions
- `NETWORK_ERROR`: Network connectivity issue
- `DISK_FULL`: Insufficient disk space
- `ENV_VAR_MISSING`: Required environment variable not set
- `ENV_VAR_MISSING`: Required environment variable not set

## Error Handling and Retry Logic

Expand Down
2 changes: 1 addition & 1 deletion configuration/moonraker.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ info_tags:

[update_manager klipper]
channel: dev
pinned_commit: b7233d1197d9a2158676ad39d02b80f787054e20
pinned_commit: 1c96f096fdeea8e2e79237b679ed6fa944fbae5e

[update_manager moonraker]
channel: dev
Expand Down
Loading