search

ReadAlongs / Studio

Audiobook alignment for Indigenous languages
https://readalongs.github.io/Studio/
Other
38 stars 20 forks source link

Publish based on tag push instead of release PR #229

Closed joanise closed 4 months ago

joanise commented 4 months ago

PR Goal?

Revamp our publication process, and our versioning system.

Feedback sought?

Priority?

before the next release

Tests added?

n/a

How to test?

manually tested via test variant, see https://github.com/ReadAlongs/Studio/actions/runs/9862260494

Confidence?

high

Version change?

minor bump, since the current patch number is >20M, and the next patch number will be 0. But we're during for a minor release anyway!

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.22%. Comparing base (a540b8c) to head (4a333bf).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #229 +/- ## ========================================== - Coverage 87.23% 87.22% -0.01% ========================================== Files 21 21 Lines 1770 1769 -1 Branches 321 321 ========================================== - Hits 1544 1543 -1 Misses 189 189 Partials 37 37 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

joanise commented 4 months ago

This will conflict with dev.ap/versioning-patch. We need to discuss how to proceed.

Yes, but it's a very simple conflict to resolve, since it's just removing VERSION from readalongs/__init__.py and keeping the right version in readalongs/_version.py.

Oh, wait, no, but that uncovers a bug in versioning-patch: VERSION and __version__ were previously meant the be tied, with VERISON being Major.minor and __version__ being generated as Major.minor.patch. On the other hand, the format_version used in versioning-patch will need a new variable, not defined before, because we cannot assume it's always going to be the same as readalongs' Major.minor version: we might add features or make breaking changes that don't affect for the .readalong format, in which case we'll be the software minor and/or major, but we won't change the format version unless that too gets modified.