check-up-to-date fails even though files are just extracted

[krns]

I was just about to try the new version (0.21.0) and noticed that the pipeline is failing:

** (Mix) mix gettext.extract failed due to --check-up-to-date.
The following POT files were not extracted or are out of date:

I tried deleting all the POT files and extracting them again, with the same result.

My gettext configuration looked like:

    [
      write_reference_comments: false,
      sort_by_msgid: true
    ]

Because of the sort_by_msgid deprecation I tried false, :case_insensitive and :case_sensitive – same result.

Am I missing something on my side?

[maennchen]

@krns Do you get a changed file running the extract task? If yes: what is different?

Edit: nevermind, read the issue description again and i can answer my own question.

[krns]

Some clarifications because my problem description might be a bit misleading:

When I talk about "same result", I mean that the warning remains. The newly extracted POT files are actually slightly different from the POT file extracted with gettext version 0.20.0:

 ## This file is a PO Template file.
 ##
 ## "msgid"s here are often extracted from source code.
-## Add new translations manually only if they're dynamic
-## translations that can't be statically extracted.
+## Add new message manually only if they're dynamic
+## message that can't be statically extracted.
 ##
 ## Run "mix gettext.extract" to bring this file up to
 ## date. Leave "msgstr"s empty as changing them here has no

[whatyouhide]

@krns thanks for the report!

First of all, I don't think that comment change is necessary, and it's going to cause a bunch of unnecessary changes in people's projects. @maennchen, I'll revert that to the previous comment.

@krns, do you happen to have a minimal reproducing project that I could use to debug this?

[maennchen]

@whatyouhide That change was part of an effort to only use the term „message“ and not „translation“ in the whole codebase. This should make understanding the documentation simpler, since we always use the same term for messages.

„message“ is the name that gettext itself uses.

In this case, I personally think consistency is worth more than a tiny change produced in a file. I think it would be reasonable for a user of this library to update the .pot? files before expecting them to be up to date.

WDYT?

[krns]

This is a minimal reproducing project: https://github.com/krns/elixir-gettext-0.21.0-test

Steps to reproduce:

• extract via mix gettext.extract
• check if up to date via mix gettext.extract --check-up-to-date

[maennchen]

@whatyouhide We miss-interpreted the issue:

The new comment is not forced onto users at all. It will only matter for new .pot files. The issue instead comes from #335 (write_reference_comments => false)

[krns]

Sorry for the confusion and thanks for the fix! I have just successfully tested the main branch in my application.

[maennchen]

@whatyouhide Should we directly do a patch release? I think this might impact a few users...