add update flag support and logging functionality in OCR4Linux.sh

[moheladwy]

1- added update instructions using the -u or --update flag
2- added permissions: read to the linters workflows
3- closes #26

[coderabbitai]

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Summary by CodeRabbit

• New Features

  • Added a CLI update option that prints step-by-step update instructions and is documented in help.
  • Added timestamped logging that writes to stderr and optional log files for better troubleshooting.

• Chores

  • Version bumped to 1.4.1.
  • Added two new entries to version-control ignore settings.
  • Workflow configurations updated with explicit read permissions and structural formatting.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

Bumps project version to 1.4.1, adds an update helper and timestamped logging to OCR4Linux.sh with a new -u/--update option, updates CI workflow permissions/formatting, and extends .gitignore to ignore .github/plans/ and .codacy/.

Changes

Cohort / File(s)	Summary
Version Bump OCR4Linux.py, setup.sh	Version string updated from 1.4.0 to 1.4.1.
Update Feature & Logging OCR4Linux.sh	Added log_message (timestamped stderr + optional file logging) and perform_update (prints Git + setup instructions); added -u/--update parsing and help text; removed duplicate log_message definition.
Git Configuration .gitignore	Added ignore entries for .github/plans/ and .codacy/.
CI Workflows .github/workflows/bash-lint.yml, .github/workflows/python-lint.yml	Added permissions: contents: read and reflowed/adjusted job/step indentation in bash-lint; added permissions block in python-lint; lint steps preserved.

Sequence Diagram(s)

sequenceDiagram
  actor User
  participant OCR4Linux.sh as Script
  participant GitRemote as GitRemote
  participant Setup as setup.sh

  User->>Script: run `OCR4Linux.sh -u` / `--update`
  Script->>Script: log_message("update requested")
  Script->>User: print update steps (git fetch, checkout, pull, run setup.sh)
  User->>GitRemote: run suggested git commands (fetch/checkout/pull)
  GitRemote-->>User: provide updated repo
  User->>Setup: run suggested `./setup.sh`
  Setup-->>User: perform installation steps
  Script->>User: exit

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related issues

• [feat/enhancement]: Add --update / -u flag to update configuration files #26: Implements the requested -u/--update flag plus perform_update and log_message helpers as described in the issue.

Poem

🐰 I hopped in code to bump the name,
A tiny patch, but not for fame.
Press -u to fetch the newest tree,
A whisper, a log, and you're up-to-tee! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'add update flag support and logging functionality in OCR4Linux.sh' accurately summarizes the main changes in the pull request, particularly the core feature additions to the OCR4Linux.sh file.
Description check	✅ Passed	The description is related to the changeset, mentioning the addition of update instructions, permissions changes, and issue closure.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch enhance/add-update-flag-support

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}