feat: including generator meta tag in .readalong files

[roedoejet]

Rebased duplicate of #225 - please either close this one or close #225 and re-request the reviews here.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.24%. Comparing base (4a333bf) to head (2cea196).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #226      +/-   ##
==========================================
+ Coverage   87.22%   87.24%   +0.02%     
==========================================
  Files          21       21              
  Lines        1769     1772       +3     
  Branches      321      321              
==========================================
+ Hits         1543     1546       +3     
  Misses        189      189              
  Partials       37       37              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[deltork]

ready for merge

[joanise]

Just discovered an issue while discussing #229, repeating the comment here since it's relevant here:

Oh, wait, no, but that uncovers a bug in versioning-patch: VERSION and __version__ were previously meant the be tied, with VERSION being Major.minor and __version__ being generated as Major.minor.patch. On the other hand, the format_version introduced here 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.

[joanise]

Also, cli-guide.md has a reference to read-along-1.0.dtd which needs to get bumped to 1.1.

[joanise]

Please create a new constant, as mentioned above, for format_version.

[joanise]

Since I broke this code with my other PR, I rebased it for you and created the new variable. @deltork take a look and make sure it's OK. I'll approve, but it's also worth a re-review by someone else. @roedoejet ?

[joanise]

This file was in CRLF so I fixed that, hence this apparent whole file diff. Hide whitespace changes to view the real diff.

[deltork]

Also, cli-guide.md has a reference to read-along-1.0.dtd which needs to get bumped to 1.1.

DONE

[deltork]

Please create a new constant, as mentioned above, for format_version.

Thanks for doing this

Since I broke this code with my other PR, I rebased it for you and created the new variable. @deltork take a look and make sure it's OK. I'll approve, but it's also worth a re-review by someone else. @roedoejet ?

Looks good!

[joanise]

My requested changes are done.