Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

trident validate should check LF-line endings #311

Open
stschiff opened this issue Oct 23, 2024 · 2 comments
Open

trident validate should check LF-line endings #311

stschiff opened this issue Oct 23, 2024 · 2 comments

Comments

@stschiff
Copy link
Member

We recently came across an issue where I accidentally committed a Janno-file that had Windows line endings (CRLF) (see poseidon-framework/community-archive#214). Checksums were computed based on these files and committed, and the package validated. We only caught this because git converted the line endings implicitly into LF, which in turn changed the file and invalidated the checksum.

Whether or not we divide to change git-attributes (see poseidon-framework/community-archive#215), we should build in a check within trident validate that checks for line endings in all text-files that are checksum-validated, including .ind, .fam, .snp, .bim, .vcf (in the future), .geno, .bib, .janno.

@nevrome
Copy link
Member

nevrome commented Oct 23, 2024

This is probably the same issue as #302.

In today's discussion we concluded that such a check is not necessary in trident, but instead only in the public archives. Maybe that's what we try for now. Requiring one specific line ending is a change we should first encode in the Poseidon schema.

@stschiff
Copy link
Member Author

OK, we could still discuss a warning. I think even without mentioning this in the schema, we can make it "recommended" to use LF.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants