Implement versioning best practices - Githubissues

PyPSA / pypsa-usa

PyPSA-USA: An Open-Source Energy System Optimization Model for the United States

https://pypsa-usa.readthedocs.io

MIT License

35 stars 15 forks source link

Implement versioning best practices #278

Open trevorb1 opened 2 months ago

trevorb1 commented 2 months ago

Feature Request

As we get closer to having users of PyPSA-USA, adopting better versioning methods will be good.

For this ticket to be complete, I believe we will need to:

[ ] Protect the master branch, so only develop can be merged to it (or at least a dedicated PR is needed if not done already)
[ ] Set up a github action so that when a new push to main is done, the project is tagged with a version and archived to zenodo

Suggested Solution

As discussed with @ktehranchi, a GitFlow methodology may suit our needs nicely! We will have two main branches, main and develop. Our feature branches will be merged to develop, then we will only merge to master with tested developments.

Additional Info

GitHub Actions

Example 2 here shows the automatic tagging on merge to main
Maybe something like this for Zenodo, but not too sure on this one.

ktehranchi commented 2 months ago

I like the gitflow methodology.... I created a develop branch and will start using that methodology moving forward.

trevorb1 commented 2 months ago

@ktehranchi has already set up archiving new releases to zenodo! Just need that to trigger when a new push to main, I guess.