Skip to content
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

fix: rename cli parameter dataEngine to data-engine #431

Merged
merged 1 commit into from
Jan 11, 2025
Merged

fix: rename cli parameter dataEngine to data-engine #431

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions app/cmd/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ func ServerCmd() cli.Command {
Required: true,
},
cli.StringFlag{
Name: "dataEngine",
Name: "data-engine",
Usage: "The volume data engine",
Required: true,
},
Comment on lines +39 to 42
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Breaking change needs documentation

The CLI flag rename from "dataEngine" to "data-engine" is currently undocumented. The codebase lacks:

  • CLI documentation in README.md
  • A changelog file to track breaking changes
  • Migration guide for users

Please:

  1. Create a changelog file to document breaking changes
  2. Add CLI documentation to README.md
  3. Document the flag rename and provide migration steps for users
🔗 Analysis chain

LGTM! But this is a breaking change.

The renaming from "dataEngine" to "data-engine" improves consistency with kebab-case CLI naming conventions. However, this is a breaking change that will affect existing users.

Please ensure this change is:

  1. Documented in the changelog
  2. Communicated to users
  3. Released with appropriate version bump

Run this script to check for any documentation that needs updating:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any documentation files that might reference the old flag name
rg -t md -t txt "dataEngine"

Length of output: 28

Script:

#!/bin/bash
# Search for documentation files
echo "=== Documentation files ==="
fd -e md -e txt -e rst -e adoc

echo -e "\n=== Searching for both flag variations ==="
# Search for both old and new flag names in all text files
rg -l "data.?engine" --type-add 'text:*.{md,txt,rst,adoc}' -t text

echo -e "\n=== Checking for changelog ==="
fd -i changelog

Length of output: 4763

Expand Down Expand Up @@ -91,7 +91,7 @@ func ServerCmd() cli.Command {
Action: func(c *cli.Context) {
vol := volume.Volume{
Name: c.String("volume"),
DataEngine: c.String("dataEngine"),
DataEngine: c.String("data-engine"),
Passphrase: c.String("passphrase"),
CryptoKeyCipher: c.String("crytpokeycipher"),
CryptoKeyHash: c.String("crytpokeyhash"),
Expand Down
Loading