CLI fixes and visual improvements #69
Conversation
WalkthroughThe updates primarily revolve around enhancing Docker configurations and scripts across various files, standardizing them to use Docker’s detached mode for deployments and updates. Additionally, a new package metadata file was introduced, and logging functionalities were refined with updated emoticons and output formats. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Out of diff range and nitpick comments (1)
utils/config-utils.sh (1)
Line range hint
26-27: Consider usingmapfileorread -ainstead of splitting command output directly into arrays for better robustness inconfig::set_config_digests.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (7)
- test-package/docker-compose.dev.yml (1 hunks)
- test-package/docker-compose.yml (1 hunks)
- test-package/package-metadata.json (1 hunks)
- test-package/swarm.sh (1 hunks)
- utils/config-utils.sh (1 hunks)
- utils/docker-utils.sh (3 hunks)
- utils/log.sh (3 hunks)
Files skipped from review due to trivial changes (3)
- test-package/docker-compose.dev.yml
- test-package/docker-compose.yml
- test-package/package-metadata.json
Additional Context Used
ShellCheck (83)
test-package/swarm.sh (2)
[warning] 25-25: MODE appears unused. Verify use (or export if used externally).
[warning] 26-26: COMPOSE_FILE_PATH appears unused. Verify use (or export if used externally).
utils/config-utils.sh (17)
[info] 8-8: Not following: ./utils/log.sh was not specified as input (see shellcheck -x).
[warning] 26-26: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
[warning] 27-27: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
[warning] 70-70: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
[style] 75-75: See if you can use ${variable//search/replace} instead.
[warning] 82-82: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
[style] 126-126:
$/$ {} is unnecessary on arithmetic variables.
[style] 127-127:
$/$ {} is unnecessary on arithmetic variables.
[warning] 183-183: The surrounding quotes actually unquote this. Remove or escape them.
[info] 183-183: Double quote to prevent globbing and word splitting.
[info] 216-216: Double quote to prevent globbing and word splitting.
[warning] 221-221: The surrounding quotes actually unquote this. Remove or escape them.
[info] 221-221: Double quote to prevent globbing and word splitting.
[warning] 233-233: Declare and assign separately to avoid masking return values.
[info] 235-235: Double quote to prevent globbing and word splitting.
[warning] 339-339: Variable was used as an array but is now assigned a string.
[warning] 341-341: Expanding an array without an index only gives the first element.
utils/docker-utils.sh (49)
[info] 6-6: Not following: ./utils/config-utils.sh was not specified as input (see shellcheck -x).
[info] 7-7: Not following: ./utils/log.sh was not specified as input (see shellcheck -x).
[info] 66-66: Double quote to prevent globbing and word splitting.
[info] 66-66: Double quote to prevent globbing and word splitting.
[warning] 71-71: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
[info] 71-71: Double quote to prevent globbing and word splitting.
[info] 71-71: Double quote to prevent globbing and word splitting.
[warning] 75-75: Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a.
[info] 149-149: Double quote to prevent globbing and word splitting.
[info] 150-150: Double quote to prevent globbing and word splitting.
[warning] 173-173: Declare and assign separately to avoid masking return values.
[info] 174-174: Double quote to prevent globbing and word splitting.
[info] 200-200: Double quote to prevent globbing and word splitting.
[warning] 205-205: This { is literal. Check expression (missing ;/\n?) or quote it.
[warning] 205-205: This { is literal. Check expression (missing ;/\n?) or quote it.
[warning] 205-205: This } is literal. Check expression (missing ;/\n?) or quote it.
[warning] 205-205: This } is literal. Check expression (missing ;/\n?) or quote it.
[warning] 212-212: Declare and assign separately to avoid masking return values.
[info] 214-214: Double quote to prevent globbing and word splitting.
[style] 215-215:
$/$ {} is unnecessary on arithmetic variables.
[style] 217-217:
$/$ {} is unnecessary on arithmetic variables.
[info] 218-218: Double quote to prevent globbing and word splitting.
[info] 231-231: Double quote to prevent globbing and word splitting.
[info] 232-232: Double quote to prevent globbing and word splitting.
[warning] 311-311: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
[info] 327-327: Double quote to prevent globbing and word splitting.
[info] 328-328: Double quote to prevent globbing and word splitting.
[info] 338-338: Double quote to prevent globbing and word splitting.
[info] 341-341: Double quote to prevent globbing and word splitting.
[warning] 409-409: Declare and assign separately to avoid masking return values.
[info] 409-409: Double quote to prevent globbing and word splitting.
[error] 411-411: Double quote array expansions to avoid re-splitting elements.
[warning] 414-414: Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a.
[error] 419-419: Double quote array expansions to avoid re-splitting elements.
[info] 420-420: Double quote to prevent globbing and word splitting.
[warning] 433-433: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
[info] 433-433: Double quote to prevent globbing and word splitting.
[info] 456-456: Double quote to prevent globbing and word splitting.
[warning] 460-460: Declare and assign separately to avoid masking return values.
[info] 460-460: Double quote to prevent globbing and word splitting.
[warning] 461-461: Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a.
[info] 466-466: Double quote to prevent globbing and word splitting.
[warning] 467-467: Declare and assign separately to avoid masking return values.
[info] 467-467: Double quote to prevent globbing and word splitting.
[warning] 477-477: Declare and assign separately to avoid masking return values.
[info] 477-477: Double quote to prevent globbing and word splitting.
[info] 483-483: Double quote to prevent globbing and word splitting.
[warning] 546-546: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
[warning] 567-567: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
utils/log.sh (15)
[info] 19-19: Modification of BASHLOG_FILE is local (to subshell caused by (..) group).
[info] 20-20: Modification of BASHLOG_JSON is local (to subshell caused by (..) group).
[info] 21-21: Modification of BASHLOG_SYSLOG is local (to subshell caused by (..) group).
[error] 23-23: Argument mixes string and array. Use * or separate argument.
[warning] 29-29: Declare and assign separately to avoid masking return values.
[warning] 30-30: Declare and assign separately to avoid masking return values.
[info] 32-32: BASHLOG_FILE was modified in a subshell. That change might be lost.
[info] 35-35: BASHLOG_JSON was modified in a subshell. That change might be lost.
[info] 38-38: BASHLOG_SYSLOG was modified in a subshell. That change might be lost.
[warning] 44-44: Declare and assign separately to avoid masking return values.
[warning] 49-49: Assigning an array to a string! Assign as array, or use * instead of @ to concatenate.
[warning] 99-99: Declare and assign separately to avoid masking return values.
[error] 154-154: Argument mixes string and array. Use * or separate argument.
[warning] 162-162: prev_cmd appears unused. Verify use (or export if used externally).
[info] 207-207: BASHLOG_FILE was modified in a subshell. That change might be lost.
Additional comments not posted (7)
test-package/swarm.sh (3)
25-26: Verify the usage ofMODEandCOMPOSE_FILE_PATHor consider removing them if they are not used.
32-35: The script sourcing inimport_sourcesfunction looks correct.
37-61: Themainfunction handles Docker service operations appropriately and logs relevant messages.utils/log.sh (1)
Line range hint
119-151: The changes in emoticons and output format in thelogfunction enhance the visual representation and control of log outputs.utils/config-utils.sh (2)
162-162: The addition of the-dflag in thedocker stack deploycommand inconfig::await_service_runningis a good improvement for running deployments in the background.
Line range hint
1-339: The functions inconfig-utils.share well-structured and handle Docker configurations and timeouts effectively.utils/docker-utils.sh (1)
370-370: Verify the configuration file path before deploying the Docker stack.This script ensures that the configuration file exists before attempting to deploy the Docker stack. This is a crucial check to prevent runtime errors due to missing configuration files.
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
3.9.Refactor
-dflag for detached operations, streamlining service management.