Release 1.0 - Githubissues

ipaddress-gem / ipaddress

A library to handle IPv4 and IPv6 addresses in a modern and productive way.

https://rubydoc.info/gems/ipaddress/

MIT License

380 stars 98 forks source link

Release 1.0 #132

Open sandstrom opened 1 year ago

sandstrom commented 1 year ago

I've added this meta issue where we can track items that we want to complete before a 1.0 release.

TODO

[x] Remove ruby 1.8 compatibility (https://github.com/ipaddress-gem/ipaddress/pull/140)
[x] Remove mongoid stuff (https://github.com/ipaddress-gem/ipaddress/pull/139)
[x] Update Readme to Markdown (https://github.com/ipaddress-gem/ipaddress/pull/138)
[x] Update Changelog to Markdown
[ ] Switch to Github Actions for automated tests (remove Travis)
[ ] Remove .rock.yml
[ ] Remove testing for all unsupported versions of Ruby (< 3.0.0)
[ ] Cleanup gemspec, gitignore and other metadata files

Planned deprecations

[ ] Deprecated a?, b? and c? in favor of class_a_network?, class_b_network? and class_c_network?
[ ] Deprecate IPAddress(str) in favor of IPAddress.parse(str) (invoking a class like a method isn't very common in ruby, better with an explicit parse method).

@bluemonk Feel free to add/remove anything from this list, as you see fit.

sandstrom commented 1 year ago

@bluemonk A few things:

I've added three PRs above, for a few items. Let me know if you have comments!
I've added some deprecation suggestions. But I'll only add if you think they are a good idea. The plan would be to still support old logic after 1.0, so these wouldn't be breaking.

Are there other things you think we should deprecate or reconsider during an 1.0 release?
Also, I'd like to setup Github Actions for automatic tests (instead of Travis), assuming you aren't opposed?

If so, I'll need more repo access, so I can setup branch protection checks requiring passed tests before merge.

I'd also like to automate Ruby Gem releases eventually, but I need to look into that a bit in more detail. Also, no hurry with Gem release, there is still quite a few changes I'd like to get through, as outlined in the 1.0 todo-issue.

gucki commented 1 year ago

@sandstrom @bluemonk I just forked the repo because I wanted to fix <=> failing when used with nil, but was surprised to see this already fixed on master. What about releasing a new version before 1.0 which has all the fixes already merged to master? Especially since the last release 0.8.3 is more than 6! years old...

sandstrom commented 1 year ago

@gucki I'm still planning to get around to it!

It's just been very busy at work the last few months.

javierav commented 6 months ago

Hi @sandstrom! What is the status of this project almost a year later? How I can help?

sandstrom commented 6 months ago

@javierav A few ideas:

Open a PR for moving to Github Actions
Go through the codebase and add deprecations where reasonable (see above).
Remove testing for all unsupported versions of Ruby.

Happy to discuss thoughts/details in advance, if you have questions.

For all of the above, unless you feel very confident about doing it, a good start is probably to write a small plan, a bullet list of 5-10 items, so we can discuss details before you get started.

In either case, I haven't forgotten about this, and still have plans to get this over the finish line. It's just been very busy the past 3 months with moving and other things. Should get better in 1-2 months hopefully.

DougPuchalski commented 1 month ago

Bumping, in particular interested in getting https://github.com/ipaddress-gem/ipaddress/pull/86

jcoetzee commented 1 month ago

Any chance we can get an interim 0.9 release with the code base as it stands now?