search

epcpower / sunspec-demo

MIT License
1 stars 0 forks source link

add release documentation #9

Closed gordon-epc closed 3 years ago

gordon-epc commented 3 years ago

The goal of this pull request is to add release documentation, per issue #8.

gordon-epc commented 3 years ago

Did a significant rewrite of the release process, which uses semver, no release candidates, and uses the feature branch workflow. This will require changing the develop branch name to main. And this merged pull request will be tagged as v0.1.0.

gordon-epc commented 3 years ago

On develop and main, my idea was to change develop to main, but I didn't exactly know how to do that through the pull request process. Do you even want me to change develop to main?

altendky commented 3 years ago

develop came from git flow. I'm good with not having the full formality of that. I don't know the present state but with the master->main opinion shift last year GitHub was working on some tooling. For awhile they recommended waiting. If they recommend switching now and you want to go through that, this is a fine place and time to try that process out. Well, it wouldn't be in a PR but... this repo and this week/month... if we do that first we'll have this as an example PR to see if it gets adjusted properly to the new default branch.

gordon-epc commented 3 years ago

Given the release process I wrote, it didn't make sense to tag releases on a branch named develop. I understand the gitflow methodology of having separate master/main and develop branches, but currently gitflow seems like overkill for this repo. The branch renaming process appears to be straightforward using the github interface, plus a few commands on local branches. I assume this would only affect you and me. Low risk, as far as I can tell. I say we go for it immediately after this pull request is approved.