Task #12072 (closed)
Opened 5 years ago
Closed 5 years ago
Schema change doc needs moving and updating for breaking builds
Reported by: | mtbcarroll | Owned by: | sbesson |
---|---|---|---|
Priority: | minor | Milestone: | 5.1.0-m1 |
Component: | Documentation | Version: | 5.0.0 |
Keywords: | n.a. | Cc: | hflynn, mtbcarroll, bpindelski, jamoore |
Resources: | n.a. | Referenced By: | n.a. |
References: | n.a. | Remaining Time: | n.a. |
Sprint: | n.a. |
Description
http://www.openmicroscopy.org/site/support/omero5/developers/schema-changes.html should discuss the GH breaking label and corresponding CI jobs: how to mark one's PRs and what happens about review. Or, it should reference some other page that explains the process, as I guess it is not only schema changes that make a PR a breaking one.
Change History (8)
comment:1 Changed 5 years ago by sbesson
comment:2 Changed 5 years ago by mtbcarroll
Sounds good to me. Though, although the current CI page lists the breaking jobs, probably more needs to be said somewhere about the idea and intended workflow behind them.
comment:3 Changed 5 years ago by hflynn
@sbesson is right, this stuff belongs in the contributing docs not the OMERO developer docs. I'll edit the ticket name.
comment:4 Changed 5 years ago by hflynn
- Summary changed from Schema change developer page needs updating for breaking builds to Schema change doc needs moving and updating for breaking builds
comment:5 Changed 5 years ago by sbesson
- Owner sbesson deleted
Opened https://github.com/openmicroscopy/ome-documentation/pull/699 which reorganizes the CI section of the contributing documentation and includes a more thorough description of the breaking workflow (labels, goals, jobs). This should provide placeholders for moving/referencing the model and schema changes.
comment:6 Changed 5 years ago by mtbcarroll
Further to-do's:
- Explain if it's okay if integration-broken jobs aren't green.
- Breaking upgrade: Job description should mention it does both from-previous-patch and from-previous-version, and the last section of the schema changes page should mention how one needs to actually provide both scripts.
comment:7 Changed 5 years ago by mtbcarroll
- Milestone changed from Unscheduled to 5.1.0-m1
- Owner set to sbesson
comment:8 Changed 5 years ago by sbesson
- Resolution set to fixed
- Status changed from new to closed
My immediate with regard to the ticket description is why is this page under the OMERO developer documentation. Two obvious problems I can spot:
Unless someone argues, my preference would be to move this particular page to the Contributing documentation and link the corresponding bits to the relevant section of continuous integration page.