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

Automatically updating HADDOCK patch version #696

Closed
wants to merge 6 commits into from

Conversation

VGPReys
Copy link
Contributor

@VGPReys VGPReys commented Sep 14, 2023

  • You have sticked to Python. Please talk to us before adding other programming languages to HADDOCK3
  • Your PR is about CNS
  • Your code is well documented: proper docstrings and explanatory comments for those tricky parts
  • You structured the code into small functions as much as possible. You can use classes if there is a (state) purpose
  • Your code follows our coding style
  • You wrote tests for the new code
  • tox tests pass. Run tox command inside the repository folder
  • -test.cfg examples execute without errors. Inside examples/ run python run_tests.py -b
  • PR does not add any dependencies, unless permission granted by the HADDOCK team
  • PR does not break licensing
  • Your PR is about writing documentation for already existing code 🔥
  • Your PR is about writing tests for already existing code :godmode:

The basic idea is to have an automated procedure to update HADDOCK3 versions based on current state of the repository.

For this:

  • git log data is searched for the last merged pull request and its commit id is retrieved.
  • This commit id is then used to update the patch version (v_patch) of haddock.

Also, the setup.py uses this function to automatically update the version at setup time.

The file responsible of all of this is patch_update.py, and have been added in the tox.ini for lint checks.

Hopefully, this closes #679 .

@VGPReys VGPReys self-assigned this Sep 14, 2023
@VGPReys VGPReys closed this Nov 17, 2023
@VGPReys VGPReys added the feature New feature request label Dec 7, 2023
@VGPReys VGPReys deleted the autamatic-patch-update branch January 5, 2024 11:24
@VGPReys VGPReys restored the autamatic-patch-update branch January 5, 2024 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add version number in the log file
1 participant