Skip to content

Fix --version-id → --versionid in CLI, test script, and README #42

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
Tahoora-Tabassum wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix --version-id → --versionid in CLI, test script, and README #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fb3f06
Fix --version-id -> --versionid in CLI
Tahoora-Tabassum Dec 23, 2025
d4bb454
Fix --version-id -> --versionid in test script
Tahoora-Tabassum Dec 23, 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
2 changes: 1 addition & 1 deletion databusclient/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def app():

@app.command()
@click.option(
"--version-id", "version_id",
"--versionid", "version_id",
Copy link

@coderabbitai coderabbitai bot Dec 23, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

# Search for any remaining references to --version-id in the codebase
rg -n '\-\-version\-id' --type-list | head -20

Repository: dbpedia/databus-python-client

Length of output: 462

🏁 Script executed:

# Search for --version-id across all files
rg -n '\-\-version\-id' -g '!.git'

Repository: dbpedia/databus-python-client

Length of output: 1080

🏁 Script executed:

# Check for README and CHANGELOG files
fd -e md -e txt -e rst | grep -iE '(readme|changelog|migration|history)' | head -20

Repository: dbpedia/databus-python-client

Length of output: 82

🏁 Script executed:

# Get context around the change in cli.py to understand the full scope
git ls-files | grep -E 'cli\.py'

Repository: dbpedia/databus-python-client

Length of output: 93

🏁 Script executed:

# Check if there are references to issue #37
rg -n '#37' -g '!.git'

Repository: dbpedia/databus-python-client

Length of output: 55

🏁 Script executed:

# View the cli.py file around line 19 to understand the flag change
cat -n databusclient/cli.py | head -50

Repository: dbpedia/databus-python-client

Length of output: 2604

🏁 Script executed:

# Search for --versionid (the new flag) to see if it's used elsewhere
rg -n '\-\-versionid'

Repository: dbpedia/databus-python-client

Length of output: 228

🏁 Script executed:

# Check for CHANGELOG, HISTORY, or version notes
fd -e md -e txt -e rst | xargs rg -l -i 'changelog|breaking change' 2>/dev/null | head -10

Repository: dbpedia/databus-python-client

Length of output: 55

🏁 Script executed:

# Search for test files that might reference the flag
fd -e py | xargs rg -l 'version.?id|versionid' 2>/dev/null

Repository: dbpedia/databus-python-client

Length of output: 145

🏁 Script executed:

# Check git history for this specific change if possible
git log --oneline -n 20 -- databusclient/cli.py 2>/dev/null || echo "Git history not available"

Repository: dbpedia/databus-python-client

Length of output: 127

🏁 Script executed:

# Check test_databusclient.py for version_id/versionid references
cat -n tests/test_databusclient.py | grep -A 2 -B 2 'version'

Repository: dbpedia/databus-python-client

Length of output: 293

🏁 Script executed:

# Check client.py to see how version_id is used
rg -n 'version_id' databusclient/client.py -A 2 -B 2

Repository: dbpedia/databus-python-client

Length of output: 1356

🏁 Script executed:

# Verify the README line count and exact content of the outdated references
cat -n README.md | sed -n '180,270p'

Repository: dbpedia/databus-python-client

Length of output: 4921

🏁 Script executed:

# Check if there are any deprecation warnings or migration notices in the code
rg -n 'deprecat|migrat|breaking|version-id' databusclient/ -i

Repository: dbpedia/databus-python-client

Length of output: 55

Update README.md and add migration documentation for --version-id to --versionid flag rename.

The code change is syntactically correct, but the migration is incomplete. README.md still references the old --version-id flag in 5 places (lines 186, 205, 209, 226, 264) and all example commands use the outdated flag name. Users following the documentation will encounter errors. Additionally, no CHANGELOG or migration guide exists for this breaking change.

Required before merge:

  • Update all README.md examples from --version-id to --versionid
  • Add a CHANGELOG entry documenting this breaking change
  • Add deprecation messaging or migration guide in the documentation
🤖 Prompt for AI Agents 
In databusclient/cli.py around line 19 the flag was renamed from --version-id to
--versionid but the repository docs and migration notes were not updated; update
README.md occurrences at lines 186, 205, 209, 226, and 264 replacing
--version-id with --versionid in all example commands, add a CHANGELOG entry
describing the breaking change and the date/version, and add a short
migration/deprecation note in the documentation (README or a new MIGRATION.md)
explaining the rename and showing the before/after command examples and a
suggested temporary compatibility/deprecation warning for users.

required=True,
help="Target databus version/dataset identifier of the form "
"<https://databus.dbpedia.org/$ACCOUNT/$GROUP/$ARTIFACT/$VERSION>",
Expand Down
2 changes: 1 addition & 1 deletion test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

databusclient deploy \
--version-id "https://d8lr.tools.dbpedia.org/hopver/testGroup/testArtifact/1.0-alpha/" \
--versionid "https://d8lr.tools.dbpedia.org/hopver/testGroup/testArtifact/1.0-alpha/" \
--title "Test Title" \
--abstract "Test Abstract" \
--description "Test Description" \
Expand Down