Added action to prevent changing msgid #1351
Conversation
|
Wow, this is great! Thank you for putting this together! I can see what this does, but I wonder if it would be easier to understand if it was a Python script? They can be embedded directly into the GH action: - name: Update dependency graph
run: |
import fileinput, re, sys
NAME = '${{ needs.setup.outputs.name }}'
NEW_VERSION = '${{ needs.setup.outputs.new-version }}'
for line in fileinput.input(inplace=True):
sys.stdout.write(
re.sub(f'/images/{NAME}-.+\\.svg',
f'/images/{NAME}-{NEW_VERSION}.svg', line))
shell: python3 {0} src/lib.rsThough saying this, it would be better to just create a |
|
I think we can merge this as a shell script already, but if you find time, I would be interested in seeing it as a Python script instead. That would hopefully help with some of the more obscure (to me) lines such as if sed -n ${changed_line}p $filename | grep -q msgstr; then |
|
Definitely easier to understand (and write) as a Python script. I can turn this into a |
Awesome!
Yeah, it seems to be available right out of the box.
You should be able to do - name: Configure Git user
run: python3 .github/workflows/prevent-changing-msgid.py(not tested... I think the path will be relative to the repository root, but perhaps it's relative to |
|
Switched to Python and re-tested (links in the first post updated accordingly) |
This enforces a consistent formatting for the PO files. The goal of this is to avoid large diffs due to random and unnecessary reformatting. We use the format of `msgcat`: this is also waht `msgmerge` produces and it’s easy to replicate for people by installing Gettext and running `dprint fmt`. This is a follow-up to #1351 which started enforcing that the `msgid` fields don’t change due to reformatting in a PR. If this turns out to be cumbersome, then we can disable it again.
This enforces a consistent formatting for the PO files. The goal of this is to avoid large diffs due to random and unnecessary reformatting. We use the format of `msgcat`: this is also waht `msgmerge` produces and it’s easy to replicate for people by installing Gettext and running `dprint fmt`. This is a follow-up to #1351 which started enforcing that the `msgid` fields don’t change due to reformatting in a PR. If this turns out to be cumbersome, then we can disable it again.
This enforces a consistent formatting for the PO files. The goal of this is to avoid large diffs due to random and unnecessary reformatting. We use the format of `msgcat`: this is also waht `msgmerge` produces and it’s easy to replicate for people by installing Gettext and running `dprint fmt`. The existing files were updated to match: 15 out of 18 translations already followed the new format! I incremented the POT-Creation-Date fields by one day: the precise date does not matter much since the translations in question are incomplete and not yet published. This is a follow-up to #1351 which started enforcing that the `msgid` fields don’t change due to reformatting in a PR. If this turns out to be cumbersome, then we can disable it again.
This enforces a consistent formatting for the PO files. The goal of this is to avoid large diffs due to random and unnecessary reformatting. We use the format of `msgcat`: this is also waht `msgmerge` produces and it’s easy to replicate for people by installing Gettext and running `dprint fmt`. This is a follow-up to #1351 which started enforcing that the `msgid` fields don’t change due to reformatting in a PR. If this turns out to be cumbersome, then we can disable it again.
|
Hi @noamzaks, I created #1364 to add a few comments to the script. You might want to add a few more to explain future maintainers what it does. I also notes that we should
It's not high-priority, but it would be nice to have. |
See discussion in #1344.
This checks that all
.pofiles changed in pull requests either contain changes in POT-Creation-Date (i.e. are run by the specific tool which should change msgid's), or don't change msgid's (by checking that each line changed is NOT between msgid and msgstr)I have tested this on my fork, see valid changes where the action passes, and invalid changes where it doesn't.
The action also has output for failing/passing:
passing
failing