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

Update readme for 2024 experimental release. #12

Merged
merged 3 commits into from
Jan 30, 2024

Conversation

ryan-kipawa
Copy link
Collaborator

@ryan-kipawa ryan-kipawa commented Jan 26, 2024

This PR prepares mikeplus-python for an experimental release for MIKE+ 2024. The package will still not be deployed to PyPI. Users wanting to test out the package will need to install from this repository.

Additionally, this PR proposes a versioning and branch strategy for mikeplus-python.

Versioning

The versioning is consistent with this standard. I propose that releases be made in step with MIKE+ releases as follows:

  • MIKE+ 2024 = MIKE+ PY v2024.0.0
  • MIKE+ 2024 Update 1 = MIKE+ PY 2024.1.0
  • Any mini releases / bug fixes of MIKE+ PY in between MIKE+ releases adds a trailing digit (e.g. MIKE+ PY v2024.0.1)
  • There always exists a tag indicating the latest MIKE+ PY version for a particular MIKE+ version (e.g. MIKE+ PY v2024.0-latest refers to the latest MIKE+ PY version v2024.0.x)

Branch strategy

Using a single main branch is problematic because of the different MIKE+ versions. We want to make it easy for people to contribute, as well as to fix minor bugs themselves in a particular version they're using. For this I propose:

  • The 'main' branch is always consistent with the latest public release of MIKE+
  • The 'dev' branch is used for internal development versions of MIKE+
  • We maintain branches for each release of MIKE+ (e.g. branch 2024.0, 2024.1, 2025.0, 2025.1, etc)
  • All of the above mentioned branches should have appropriate protections.

If you have any other suggestions feel free to comment :)

I have already added some tags for v2024.0.0 and v2024.0-latest. It is back a few commits, since the latest main branch appears inconsistent with MIKE+ 2024 public release.

CHANGELOG.md Outdated Show resolved Hide resolved
@ecomodeller
Copy link
Member

❗ Don't forget to update this line https://github.com/DHI/mikeplus-python/blob/9cab8f3946a44bf2b0a96e4baa84c42d8ca2a5ad/pyproject.toml#L10

@ryan-kipawa ryan-kipawa marked this pull request as ready for review January 30, 2024 06:47
@ryan-kipawa ryan-kipawa merged commit b20d77e into main Jan 30, 2024
1 check passed
@ryan-kipawa ryan-kipawa deleted the 2024-experimental-release branch October 31, 2024 07:00
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

Successfully merging this pull request may close these issues.

4 participants