gobuffalo/buffalo

make the current version v1 and configure branch structure

sio4 opened this issue · 2 comments

sio4 commented

Make the current version v1 and configure branch structure for the future development

  • check, fix, and merge recent PRs/issues if any
  • release v1.0.0 with the current version
  • make a new branch to maintain v1
  • configure main as the active development branch for the next major update
  • deprecate development branch
  • setup branch protection and other automation configurations

This is the reason I want to mark the current version of the buffalo core library (https://github.com/gobuffalo/buffalo) as v1 so the users can use the current version on their production with the belief of the version will last be stable even though the buffalo grow further. When the developers use v0, they could be more careful and will have concerns about possible breaking changes. Meanwhile, I believe the current version is already ready for production, and making it v1 will help both the users to use it in production and us to develop the next version with no strong concern about breaking changes.

Yes. I think we should do that.

OK, then I will work on it (the core library versioning) this week. (actually, I am more passionate about the library part :-)

Originally posted by @sio4 in gobuffalo/cli#207 (comment)

sio4 commented

Hi @gobuffalo/all,
All done! Now the stable version of Buffalo core is v1.0.0! Congratulations! 🎉

Since the go module's import path for v0 and v1 is the same, users are able to update their version of Buffalo core library with go get github.com/gobuffalo/buffalo and we can now safely works on v2 and v1 maintenance!

Be careful working on those two branches. The v1 branch is now only for the maintenance for the stable release (bug fix only) and all the new feature implementation and/or breaking changes should go to the main branch, and the new v2 versions should be released as v2.0.0-alpha000 for a while.

I will take care of the side effects of this action if any, and please let me know if there is any issue with this version change and the branch structure.

This issue will remain open for a week or so as a night watch.

sio4 commented

Additionally, check all existing issues and PRs for support packages under Buffalo core and fix/close them if that can be done within a few days:

Depth 7 (No dependency)

  • flect has 6 open issues --> all open issues were addressed and released v0.3.0
  • github_flavored_markdown has 1 open issue --> security update and released v1.1.2
  • envy has 2 open issues and 1 open PR --> now v1.10.2. only issues/PR for v2 remains
  • logger has 1 open issue and 1 open PR --> now v1.0.7. one PR for v2 remains
  • here has no open issue/PR --> v0.6.7 with module updates (no open issue)
  • packd has 1 open issue --> v1.0.2 with module updates
  • httptest has no open issue/PR --> v1.5.2 with module updates (no open issue)
  • events has no open issue/PR --> v1.4.3 with module updates (no open issue)
  • nulls has no open issue/PR --> v0.4.2 with module updates (no open issue)
  • refresh has no open issue/PR --> v1.13.2 with module updates (no open issue)

Depth 6

  • attrs has no open issue/PR --> v1.0.3 with module updates (no open issue)
  • grift has no open issue/PR --> v1.5.2 with module updates (no open issue)
  • meta has 1 open issue --> v0.3.3 with module updates (no issue for v0)
  • validate has 2 open issues --> v3.3.3 with module updates (no issue to be fixed)

Depth 5

  • tags has 10 open issues and 1 open PR --> v3.1.4 with module updates (still 7 open issues, mostly FRs)

Depth 4

  • helpers has no open issue/PR --> v0.6.6 with module updates (no open issue)

Depth 3

  • plush has 14 open issues --> v4.1.15 with module updates and more (now 7 issues)

Depth 2

  • fizz has 20 open issues and 6 open PRs --> v1.14.3 with small fix and deps (18+4 left)
  • genny has 2 open issues -> v2.0.13 with module updates (1 proposal issue)

Depth 1

  • pop has 115 open issues and 9 open PRs --> v6.0.7 with many bugfixes (94 issues and 4 PRs)

Depth 0

  • buffalo itself has 29 open issues