search

siesta-project / aiida_siesta_plugin

Source code for the AiiDA-Siesta package (plugin and workflows). See wiki
Other
6 stars 11 forks source link

Consider switching to gitflow model (develop branch)? #32

Closed ltalirz closed 5 years ago

ltalirz commented 5 years ago

As of today, the AiiDA registry gets information on capability of aiida-siesta from the setup.json from the master branch fo the repository.

This means it currently reads version 1.0, while it isn't actually released yet https://aiidateam.github.io/aiida-registry/plugins/siesta.html

Most plugins follow the gitflow model, where you develop things on the develop branch and merge into master, whenever you make a release. Perhaps would make sense here as well?

bosonie commented 5 years ago

Dear @ltalirz , The version is ready to be released, I just got caught in some personal problems last week and I couldn't conclude it. I'll do it tomorrow. Next time we will be more careful on the timing of "merge to master" and "make the release". We were actually reconsidering to call it 1.0b1. Could you give your opinion on that?

ltalirz commented 5 years ago

hi @bosonie, thanks for the quick update!

I'll do it tomorrow. Next time we will be more careful on the timing of "merge to master" and "make the release".

No worries, this was just something I noticed and wanted to mention.

We were actually reconsidering to call it 1.0b1. Could you give your opinion on that?

If you go for 1.0.0b1, keep in mind that users doing pip install aiida-siesta will still get the old version (they will get the latest version only with --pre). So, the questions is whether this is what you would prefer.

Unless you are still planning severe API changes, I would personally lean towards 1.0.0 (and simply release bug fix releases if needed) but it's your choice.

bosonie commented 5 years ago

This is exactly my concern, but I saw that many plugins are still in beta. Our plugin has the phonon part missing, but all the other basic functionalities are ok. Thanks @ltalirz for the suggestion, we will decide tomorrow morning.

ltalirz commented 5 years ago

As long as the addition you are planning is backwards compatible (i.e. existing scripts using the plugin will continue to work) I wouldn't be too worried about releasing 1.0

bosonie commented 5 years ago

Sorted, we went for version 1.0.0. Thanks for your help @ltalirz.