Here are things that would be ideal:
- When people visit github.com/robfig/cron, I would like them to see the v3 version
- Similarly, when people create pull requests, I would like them to be against the v3 branch by default.
- I would like to have godoc available in the usual place. godoc.org does not seem to be module aware, so https://godoc.org/github.com/robfig/cron/v3 does not work.
- "master" reflects ongoing development of v3, rather than being frozen in time as the v1 branch. (minor)
I tried to accomplish this by changing the "default branch" from master to v3. However, that had the effect of breaking everyone who uses "go get" without version pinning, since they expected v1. I just reverted that settings change.
Here's my next-best solution:
- Update the README for v1 and v2 to have a big banner to direct folks to v3
- Link to godoc via gopkg.in: https://godoc.org/gopkg.in/robfig/cron.v3
That works, but it's problematic because (AFAIK) users can NOT actually import `gopkg.in/robfig/cron.v3`, they must import `github.com/robfig/cron/v3`, so the instruction that godoc.org adds at the top of every page to import this package will fail.
Unless I'm missing something, not having godoc for module versions seems like a pretty major problem. Is there something I'm missing? How are other maintainers dealing with this?
Thanks for your advice,
-Rob