search

AcademySoftwareFoundation / OpenTimelineIO

Open Source API and interchange format for editorial timeline information.
http://opentimeline.io
Apache License 2.0
1.4k stars 276 forks source link

Release v0.16.0 changes #1716

Closed reinecke closed 3 months ago

reinecke commented 3 months ago

This is the release of items from Milestone 18 (Public Beta 16)

codecov-commenter commented 3 months ago

Codecov Report

Attention: Patch coverage is 41.02564% with 23 lines in your changes are missing coverage. Please review.

Project coverage is 79.95%. Comparing base (abe8308) to head (a683399).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716/graphs/tree.svg?width=650&height=150&src=pr&token=mfnfUB4h7u&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation)](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) ```diff @@ Coverage Diff @@ ## main #1716 +/- ## ========================================== - Coverage 79.97% 79.95% -0.02% ========================================== Files 197 197 Lines 21867 21879 +12 Branches 4338 4342 +4 ========================================== + Hits 17488 17494 +6 - Misses 2249 2252 +3 - Partials 2130 2133 +3 ``` | [Flag](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) | Coverage Δ | | |---|---|---| | [py-unittests](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) | `79.95% <41.02%> (-0.02%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) | Coverage Δ | | |---|---|---| | [src/opentimelineio/composition.h](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&filepath=src%2Fopentimelineio%2Fcomposition.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL2NvbXBvc2l0aW9uLmg=) | `45.16% <100.00%> (ø)` | | | [src/opentimelineio/externalReference.h](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&filepath=src%2Fopentimelineio%2FexternalReference.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL2V4dGVybmFsUmVmZXJlbmNlLmg=) | `100.00% <ø> (ø)` | | | [src/opentimelineio/generatorReference.h](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&filepath=src%2Fopentimelineio%2FgeneratorReference.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL2dlbmVyYXRvclJlZmVyZW5jZS5o) | `100.00% <ø> (ø)` | | | [src/opentimelineio/imageSequenceReference.h](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&filepath=src%2Fopentimelineio%2FimageSequenceReference.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL2ltYWdlU2VxdWVuY2VSZWZlcmVuY2UuaA==) | `48.27% <ø> (ø)` | | | [src/opentimelineio/item.h](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&filepath=src%2Fopentimelineio%2Fitem.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL2l0ZW0uaA==) | `100.00% <100.00%> (ø)` | | | [src/opentimelineio/mediaReference.h](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&filepath=src%2Fopentimelineio%2FmediaReference.h&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL21lZGlhUmVmZXJlbmNlLmg=) | `100.00% <ø> (ø)` | | | [src/opentimelineio/composition.cpp](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&filepath=src%2Fopentimelineio%2Fcomposition.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL2NvbXBvc2l0aW9uLmNwcA==) | `55.91% <0.00%> (ø)` | | | [src/opentimelineio/gap.cpp](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&filepath=src%2Fopentimelineio%2Fgap.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL2dhcC5jcHA=) | `88.88% <50.00%> (ø)` | | | [src/opentimelineio/deserialization.cpp](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&filepath=src%2Fopentimelineio%2Fdeserialization.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL2Rlc2VyaWFsaXphdGlvbi5jcHA=) | `35.27% <0.00%> (-0.09%)` | :arrow_down: | | [src/opentimelineio/stackAlgorithm.cpp](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree&filepath=src%2Fopentimelineio%2FstackAlgorithm.cpp&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation#diff-c3JjL29wZW50aW1lbGluZWlvL3N0YWNrQWxnb3JpdGhtLmNwcA==) | `29.12% <44.44%> (-0.58%)` | :arrow_down: | | ... and [1 more](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) | | ... and [1 file with indirect coverage changes](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation). Last update [abe8308...a683399](https://app.codecov.io/gh/AcademySoftwareFoundation/OpenTimelineIO/pull/1716?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AcademySoftwareFoundation).
meshula commented 3 months ago

(I'm not objecting to landing the ws changes, just noting that I checked to see if anything changed within the ws and didn't spot such, a separate ws PR would've required less brain juice ;) )

jminor commented 3 months ago

@reinecke you mentioned "check the README.md for any updates" in the description, but I don't see any README changes in this PR. Did I misunderstand something?

reinecke commented 3 months ago

@jminor sorry - that was a copy/paste error in my change summary. No changes intended to README.

reinecke commented 3 months ago

@meshula We currently have running clang-format as part of our release steps - I agree that those changes are a bit nerve-racking for this step in the process.

Seems like maybe we should do one of the following:

I don't recall if we've discussed either of these before. Do you have strong feelings about either one of these?

darbyjohnston commented 3 months ago

It would also be nice to relax the 80 column limit, I'm not sure some of those formatting changes are an improvement.

ssteinbach commented 3 months ago

It might make more sense to have a deliberate command that executes the C++ format. The reason we landed on this pattern was that we can be permissive as people work and conform the style together in one shot to make sure that releases have consistent formatting. Typically, I would run the C++ format as a separate command and poke through the code, eg: https://github.com/AcademySoftwareFoundation/OpenTimelineIO/commit/0aa7765b6f620af9e456bd93509eff473c527e3a

that would let the CI run and folks look at stuff before landing it.

That said, since I was largely doing the releases on my own, katamari-ing everything together was less overhead for me.

The changes themselves look good to me.

ssteinbach commented 3 months ago

oh yeah - and the checklist suggests reading through the readme to see if anything changed. We might want to add something to the readme for this release noting that its the last release with all the adapters together? I'm not sure off the top of my head of anything else that should be added there.

reinecke commented 3 months ago

@ssteinbach @jminor I made a quick update to the readme noting people should start using OpenTimelineIO-Plugins to get the full compliment of adapters.