Skip to content

58 remove version management and enforcement#59

Merged
howethomas merged 5 commits intomainfrom
58-remove-version-management-and-enforcement
Sep 19, 2025
Merged

58 remove version management and enforcement#59
howethomas merged 5 commits intomainfrom
58-remove-version-management-and-enforcement

Conversation

@howethomas
Copy link
Contributor

No description provided.

- Updated the vCon class to remove mandatory versioning, allowing vCons to be created without the "vcon" field.
- Adjusted related methods and tests to ensure compatibility with the new optional versioning.
- Enhanced documentation to reflect changes in version handling and constructor behavior.
- Updated tests to verify that vCons can be created and loaded without a version field, preserving existing functionality.
Added a comprehensive API reference for the vCon library in API_REFERENCE.md, detailing classes, methods, constants, and usage examples. Updated LLM_GUIDE.md to expand on vCon 0.3.0 features, including advanced party attributes, dialog types, extensions, civic address, party history, multimedia handling, security, validation, and best practices for LLM integration.
…agement

- Revised API_REFERENCE.md to reflect the removal of the mandatory version field and the elimination of the `strict_version` parameter from method signatures.
- Updated GUIDE.md to indicate that the `vcon` field is now optional and to provide examples of creating vCons without version fields.
- Modified MIGRATION_GUIDE.md to outline changes in version management and provide migration steps for users transitioning to the new system.
- Adjusted README.md and other documentation files to ensure consistency with the latest vCon specification updates.
@howethomas howethomas linked an issue Sep 18, 2025 that may be closed by this pull request
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

This is the final PR Bugbot will review for you during this billing cycle

Your free Bugbot reviews will reset on September 28

Details

Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.

To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

Bug: Optional Property Access Raises KeyError

The vcon property getter directly accesses self.vcon_dict["vcon"]. Since the vcon field is now optional (as indicated by the diff), accessing this property on objects without a version field will raise a KeyError. It should use .get("vcon") to return None when the field is absent, aligning with its Optional[str] return type.

src/vcon/vcon.py#L1876-L1885

https://github.com/vcon-dev/vcon-lib/blob/44fe21325ce17fe64fcad8764cc649e7cde7b78b/src/vcon/vcon.py#L1876-L1885

src/vcon/vcon.py#L1419-L1420

vcon-lib/src/vcon/vcon.py

Lines 1419 to 1420 in 44fe213

# Validate required fields.
required_fields = ["uuid", "created_at"]

src/vcon/vcon.py#L1389-L1392

vcon-lib/src/vcon/vcon.py

Lines 1389 to 1392 in 44fe213

This method generates a new RSA key pair that can be used for signing
and verifying vCons.
Returns:

src/vcon/vcon.py#L1895-L1898

https://github.com/vcon-dev/vcon-lib/blob/44fe21325ce17fe64fcad8764cc649e7cde7b78b/src/vcon/vcon.py#L1895-L1898

src/vcon/vcon.py#L931-L934

vcon-lib/src/vcon/vcon.py

Lines 931 to 934 in 44fe213

None,
)
if dialog:
logger.debug(f"Found dialog with {by}={val}")

src/vcon/vcon.py#L1749-L1752

https://github.com/vcon-dev/vcon-lib/blob/44fe21325ce17fe64fcad8764cc649e7cde7b78b/src/vcon/vcon.py#L1749-L1752

Fix in Cursor Fix in Web


Comment @cursor review or bugbot run to trigger another review on this PR

- Updated index.html to redirect to the latest documentation and added a user-friendly message.
- Removed obsolete vcon.html, dialog.html, and party.html files as part of the transition to the new documentation structure.
- Introduced version_management.rst to document changes in version handling, including the optional nature of the version field and removal of strict version enforcement.
- Updated conf.py to reflect the new version number (0.7.0) and adjusted index.rst to include the new version management section.
- Modified tests to accommodate changes in the vCon class, ensuring compatibility with the new optional versioning system.
@howethomas howethomas merged commit ca6bab4 into main Sep 19, 2025
5 checks passed
@howethomas howethomas deleted the 58-remove-version-management-and-enforcement branch September 19, 2025 01:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove version management and enforcement

1 participant