follow semantic versioning

mimoralea / gym-walk

Random walk OpenAI Gym environment.

MIT License

19 stars 9 forks source link

follow semantic versioning #6

Open MatthewCaseres opened 2 years ago

MatthewCaseres commented 2 years ago

"Once a versioned package has been released, the contents of that version MUST NOT be modified. Any modifications MUST be released as a new version." https://semver.org/

I don't know which version of 0.0.1 is compatible with the dependencies here - https://github.com/mimoralea/gdrl/issues/29, maybe they all are up until the change from 0.0.1 to 0.0.2, unsure.

mimoralea commented 2 years ago

I think you're referring to me updating the package at some point but not moving up the version, right? That was my mistake here. Open to suggestions on how to do this right--I'm not a pro at CI/CD test or even software engineering. Any help is appreciated.

MatthewCaseres commented 2 years ago

In the right sidebar of the repo you will see a section that says "releases" and this release is something you would manually create. When you create the release we can run a workflow like this and it will

[ ] bump the version to have the tag specified in the release ("0.3.0" for the next release of this package)
[ ] publish the package to PyPI

Having formal releases in this way would resolve this issue I think. I will try to get a PR done.