flatland-association / flatland-rl

The Flatland Framework is a multi-purpose environment to tackle problems around resilient resource allocation under uncertainty. It is designed to be a flexible and method agnostic to solve a wide range of problems in the field of operations research and reinforcement learning.
https://www.flatland-association.org/
MIT License
23 stars 7 forks source link

Publish package #50

Closed fnberta closed 1 year ago

fnberta commented 1 year ago

The idea for publishing is that the CHANGELOG.md file is the source of truth for the version number. To make a new release, you add a new version entry in the changelog and push and merge this change. A github action will detect a new version number and build and publish a new package. The action also adds a git tag and github release reflecting the new version.

However, there is some logic needed for this and we want a way to publish until this is in a good shape. This PR adds a simple workflow that listens to PRs being merged to main whose head branch is release/<version-number>. It uses the version-number part to version the package.