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

Jump to bottom

Add an automatic check of version consistency in documentation #5890

Closed
neubig opened this issue Dec 29, 2024 · 2 comments · Fixed by #5891
Closed

Add an automatic check of version consistency in documentation #5890

neubig opened this issue Dec 29, 2024 · 2 comments · Fixed by #5891
Assignees
@neubig
Labels
enhancement New feature or request fix-me Attempt to fix this issue with OpenHands

Comments

@neubig
Copy link
Contributor

neubig commented Dec 29, 2024

What problem or use case are you trying to solve?

When we update versions in documentation, they are specified in many different places across the codebase, and sometimes they get out of sync.

Describe the UX of the solution you'd like

It would be good to have automatic checks that our version are consistent.

Do you have thoughts on the technical implementation?

To do so, we can create a linting rule in lint.yml that uses a regex to search the entire codebase for all instances of openhands:0.XX or runtime:0.XX where XX is two digits. The linting rule should check that one and only one unique value of XX is found throughout the entire codebase.
@neubig neubig added enhancement New feature or request fix-me Attempt to fix this issue with OpenHands labels Dec 29, 2024
@openhands-agent
Copy link
Contributor

OpenHands started fixing the issue! You can monitor the progress here.

@openhands-agent openhands-agent mentioned this issue Dec 29, 2024
Merged
@openhands-agent
Copy link
Contributor

A potential fix has been generated and a draft PR #5891 has been created. Please review the changes.

@neubig neubig self-assigned this Dec 29, 2024
neubig added a commit that referenced this issue Dec 29, 2024
@openhands-agent @neubig @li-boxuan
Fix issue #5890: Add an automatic check of version consistency in doc…
037457d 
…umentation (#5891)

Co-authored-by: Graham Neubig <[email protected]>
Co-authored-by: Boxuan Li <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@neubig neubig

Labels
enhancement New feature or request fix-me Attempt to fix this issue with OpenHands
Projects
None yet
Milestone
No milestone
2 participants
@neubig @openhands-agent