pypsa-usa icon indicating copy to clipboard operation
pypsa-usa copied to clipboard

Implement versioning best practices

Open trevorb1 opened this issue 1 year ago • 3 comments

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.

trevorb1 avatar Apr 18 '24 23:04 trevorb1

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

ktehranchi avatar Apr 22 '24 04:04 ktehranchi

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

trevorb1 avatar Apr 24 '24 16:04 trevorb1

I think this is complete! I'm about to do a release so we'll confirm.

ktehranchi avatar Jul 22 '24 23:07 ktehranchi