✨ Check and fix marking the version file as "generated" in file .gitattributes

[ckunki]

Summary

This ticket requests to mark the version file as "generated" in file .gitattributes.

Details

This could be implemented in method fix() In file exasol/toolbox/nox/_format.py.

Result could be like

version.py   linguist-generated

Background & Context

Reviewers can ignore generated files and focus on manual changes, making reviews easier, reducing effort for reviews and focusing on important changes.

Examples

See https://github.com/exasol/project-keeper/blob/main/.gitattributes

References

See https://github.com/exasol/project-keeper/

Task(s)

• [ ] Create parser for file .gitattributes
• [ ] Update method fix() In file exasol/toolbox/nox/_format.py.
  • [ ] Check if version file is contained already
  • [ ] If not, then add the file
• [ ] update method check() in exasol/toolbox/nox/tasks.py, too, reporting if version file is not marked as generated.

[Nicoretti]

Hi @ckunki,

Great idea, but by now the need for having a version file is obsolete for our use cases, see also importlib.metadata. So in the long run, we rather need to get rid of the version files. Therefore, I don't think it makes sense to add an automated fix for this issue.

Still very good idea, keep em coming ;)

best Nico