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.

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

Readme makes reference to missing method #74

Open
heyvito opened this issue Nov 10, 2024 · 3 comments
Open

Readme makes reference to missing method #74

heyvito opened this issue Nov 10, 2024 · 3 comments

Comments

@heyvito
Copy link

heyvito commented Nov 10, 2024

Hi there, folks! Just a heads-up: README makes reference to VersionsFile#update_with, but there's no such method. For now I'll be just appending changes to the versions file just like RubyGems.org does (and recreating it from scratch every month through a job), but is there any "canonical" way of doing it? Otherwise, should that section I mentioned be removed?

Best wishes!
— Vito

@simi
Copy link
Member

simi commented Nov 11, 2024

Current logic lives at https://github.com/rubygems/rubygems.org/blob/master/app/jobs/upload_versions_file_job.rb#L18-L24. It seems update_with is not needed, since append in README is explained at https://github.com/rubygems/compact_index?tab=readme-ov-file#versions section already. Would it make sense to remove it from readme? 🤔

@heyvito
Copy link
Author

heyvito commented Nov 11, 2024

Hi Josef! Thank you for pointing out the current logic!
I was wondering whether it would be better to remove it from the readme, or replacing it with other instructions. Wdyt?

@simi
Copy link
Member

simi commented Nov 11, 2024

@heyvito I think it is ok to just update the section pointing to /versions documentation explaining how to append gems using CompactIndex.versions(versions_file, extra_gems). Would you mind to open PR?

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

No branches or pull requests

2 participants