Farama-Foundation / miniwob-plusplus

MiniWoB++: a web interaction benchmark for reinforcement learning
https://miniwob.farama.org/
MIT License
287 stars 47 forks source link

[Proposal] Legacy code release for backward compatability #24

Closed ppasupat closed 1 year ago

ppasupat commented 1 year ago

Proposal

Create a release containing the legacy code (before migrating to Farama).

Motivation

A few projects depend on the old code structure. Examples include:

To prevent breaking such codebases, it would be nice to create a release containing the legacy MiniWoB++ code.

Pitch

Create a release at commit 833a477a8fbfbd2497e95fee019f76df2b9bd75e, which is right before the migration.

Alternatives

The release should have minimal effects on the current code development.

Checklist

pseudo-rnd-thoughts commented 1 year ago

@jkterry1 Personally I have no issue with this. We can make a v0 release with the legacy code with v1 being the new version

jkterry1 commented 1 year ago

Ya that's fine for me

pseudo-rnd-thoughts commented 1 year ago

@ppasupat How would you like to make this legacy release? Im guessing we want a pypi and github release

ppasupat commented 1 year ago

A GitHub release should be sufficient I think. PyPi would be a hassle since the code was not packaged that well, and for reproducibility, I don't want to modify the code too much.

jkterry1 commented 1 year ago

Works for me

ppasupat commented 1 year ago

Thank you. Following up on this, I think my GitHub role does not allow me to create a release candidate. Could someone help create the release?

pseudo-rnd-thoughts commented 1 year ago

@ppasupat I have given you permissions to merge PRs etc as you are the main contributor. I think this should give you permissions to create releases just could you run the release notes pass jordan or myself as farama is trying to follow a standard operating procedure. If you don't have a copy of the SOP then just message or ask on Monday

ppasupat commented 1 year ago

The release is now live at https://github.com/Farama-Foundation/miniwob-plusplus/releases/tag/v0.1.