gh-15 : change shabang for compatibility and test for bash 4.3+ and bash as shell

[bicschneider]

• Fixes drawing in readme.md for 2.0/test is not logical placed correctly #9 : drawing in readme.md for 2.0/test is not logical placed correctly
• _tests.sh script fails silently on macOS due to incompatible local -n usage #15 : change shabang for compatibility and test for bash 4.3+

Summary by CodeRabbit

• Refactor
  • Improved environment validation and error messaging for scripts, including more comprehensive checks for Bash version and git availability.
  • Enhanced script portability by updating shebang lines.
  • Minor formatting and structural improvements for better maintainability.

[coderabbitai]

Walkthrough

The changes update two Bash scripts to improve portability and structure. Both scripts now use a more portable shebang. The environment validation logic has been refactored into reusable functions within git-artifact, and _tests.sh now sources this script to perform environment checks. Minor formatting and organizational improvements were also made.

Changes

Cohort / File(s)	Change Summary
Shebang and Environment Check Refactoring _tests.sh, git-artifact	Updated shebangs to use /usr/bin/env bash for portability. Refactored environment validation into check_environment and check_git_environment functions in git-artifact. _tests.sh now sources git-artifact and calls check_environment instead of directly checking for git.
Function and Structure Enhancements git-artifact	Added new functions: check_environment, check_git_environment, show_info, and set_opts_spec. Moved option specification logic into a function. Wrapped main execution in a conditional to allow sourcing. Improved error messages and debug output.
Formatting Cleanups _tests.sh	Removed a blank line before a function definition. No other formatting or functional changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

Bashy bunnies hop with glee,
Shebangs now set so portably!
Functions split, the checks are neat,
Environment's strong beneath our feet.
With scripts refactored, clear and bright—
Our code hops forward, pure delight! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 71aff64 and 65807d5.

📒 Files selected for processing (2)

• _tests.sh (2 hunks)
• git-artifact (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• _tests.sh
• git-artifact

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch bicschneider/issue15-compatibility

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

git-artifact (1)

6-6: Fix the typo in the error message.

There's a typo: "pleaes" should be "please".

-    echo "ERROR: git-artifact only runs in bash - pleaes check that the variable"
+    echo "ERROR: git-artifact only runs in bash - please check that the variable"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 00ae9bc and a761650.

📒 Files selected for processing (3)

• README.md (2 hunks)
• _tests.sh (2 hunks)
• git-artifact (1 hunks)

🔇 Additional comments (9)

git-artifact (4)

1-1: LGTM! Improved portability with environment-based shebang.

The change from #!/bin/bash to #!/usr/bin/env bash is a good practice for better portability across different systems where bash may be installed in different locations.

---

5-11: LGTM! Good environment validation for Bash execution.

The check for BASH_VERSINFO ensures the script is running in Bash. The implementation correctly handles the case where the variable might be unset using parameter expansion with ${BASH_VERSINFO:-}.

---

13-18: LGTM! Proper Bash version compatibility check.

The version check correctly ensures Bash 4.3+ compatibility by checking both major and minor version numbers. The logic [[ "${BASH_VERSINFO[0]}" -eq 4 && "${BASH_VERSINFO[1]}" -lt 3 ]] properly identifies Bash versions below 4.3.

---

26-26: LGTM! Simplified error message.

The removal of "git-subtree" reference from the error message makes it more generic and appropriate for the git-artifact context.

_tests.sh (2)

1-1: LGTM! Consistent portability improvement.

The shebang change matches the improvement made in the main git-artifact script, ensuring consistent portability across all scripts in the project.

---

11-11: LGTM! Helpful diagnostic information.

Adding bash version output is useful for debugging and ensuring test environments meet the compatibility requirements established in the main script.

README.md (3)

43-43: LGTM! Improved contextual clarity.

The updated description "The history of git-artifact workflow can basically look like this:" provides better context and clarity compared to the previous version.

---

63-67: LGTM! Improved consistency in tag naming.

Adding the "/bin" suffix to tags (1.1/bin, 1.2/bin, 2.0/bin) makes the example more consistent and better illustrates the recommended naming convention for git-artifact workflows.

---

73-75: LGTM! Enhanced workflow example.

The addition of the checkout command and new commits (2.0/src, 2.0/test) provides a more comprehensive example of how artifacts can be appended to existing tags, which aligns well with the documentation's explanation of horizontal commit history.

[JKrag]

Tested on mac by simulating various failure modes:

• using old 3.x bash by setting #!/bin/bash
• using ZSH by setting #!/bin/zsh

Both now give decent error messages.