gitflow for Examples? - Githubissues

GMLC-TDC / HELICS-Examples

Examples for using HELICS with a variety of the supported programming languages

BSD 3-Clause "New" or "Revised" License

21 stars 20 forks source link

gitflow for Examples? #2

Closed bpalmintier closed 4 years ago

bpalmintier commented 6 years ago

Should we migrate HELICS-Examples to use a gitflow or gitflow-like structure/workflow? Notably switching to have a develop branch from which we occassionally pull ready to share versions to masters, and a more strict habit of using new branches and pull requests.

Similarly I'd propose adopting some form of semantic versioning, but perhaps where the first and second numbers match those from HELICS-src, but the third number is kept separate to mange internal updates for examples.

Thoughts?

phlptp commented 6 years ago

I think this is a good idea once this repo is operational with CI integration complete. It might be a good idea to start that alignment once we get to the 2.0 release and have the examples aligned with that release. I am not sure it makes sense to do it with the 1.X release as I think we will be trying to migrate away from that as quickly as possible once fully operational.

bpalmintier commented 6 years ago

Agreed, and seems to have been confirmed based on last week's standup discussion. I propose the path forward to be (comments welcome):

[x] 1. Tag the current master as the 1.3.1 version
[x] 2. Start a new develop branch as the beginning of the transition to gitflow. This develop branch will be synonymous with 2.0.0 until we finally tag the release
[x] 3. Branch off of that with a collection of language specific 2.0alpha/beta branches.
[x] 4. Merge these back-in to develop
[x] 5. Put disclaimers into non-updated examples and tag corresponding to latest pre-release HELICS-SRC.
[x] 6. Continue adding new languages and debugging, interim releases match HELICS-SRC 2.x with .y increment
[x] 7. When both HELICS-SRC v2.0 comes out and all pieces working with it, tag final 2.0.0 version

afisher1 commented 6 years ago

I think this is a good idea as well.

phlptp commented 4 years ago

I think this issue will be closed when we tag a 2.3 release for the examples, then we will pretty much be on track for making the repo match up with the main HELICS repo and using gitflow.

phlptp commented 4 years ago

2.3 tagged