Details
-
Type:
Improvement
-
Status: Won't Fix
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: ap_verify
-
Labels:
-
Story Points:2
-
Epic Link:
-
Sprint:AP F21-1 (June)
-
Team:Alert Production
Description
Spencer Nelson mentioned that files can be marked as generated to keep them from appearing in GitHub diffs. This would be very useful for the ap_verify datasets, whose updates include some human-unreadable text files.
In ap_verify_testdata, ap_verify_ci_cosmos_pdr2, ap_verify_ci_hits2015, and ap_verify_hits2015, mark at least the export.yaml file as generated (since this is always a dump of the "preloaded" repository). Consider also marking gen3.sqlite3 and other Gen 3 repository files; however, at least the last would need to be undone once we moved to pure Gen 3 datasets.
Attachments
Issue Links
- relates to
-
DM-29857 Create pure Gen 3 dataset management scripts for ap_verify datasets
- Done
Activity
Spencer Nelson assures me that the change will work once .gitattributes is merged, so I propose the following sequence for this ticket, derived from how Kian-Tat Lim told me to handle similarly "meta" updates to Jenkins pipelines:
- Review the .gitattributes update for all four packages, per normal procedure.
- Merge one of the packages
- Create and upload a new u/kfindeisen/
DM-30199branch in that package that updates the repository (this branch should appear in the Jira branch tracker), and use it to test the change - If all is well, merge the other packages; if not, revert the one merge and close this issue as Won't Fix
Krzysztof Findeisen
added a comment - - edited Spencer Nelson assures me that the change will work once .gitattributes is merged, so I propose the following sequence for this ticket, derived from how Kian-Tat Lim told me to handle similarly "meta" updates to Jenkins pipelines:
Review the .gitattributes update for all four packages, per normal procedure.
Merge one of the packages
Create and upload a new u/kfindeisen/ DM-30199 branch in that package that updates the repository (this branch should appear in the Jira branch tracker), and use it to test the change
If all is well, merge the other packages; if not, revert the one merge and close this issue as Won't Fix
The proposed changes look straightforward.
It still treats export.yaml the same in diffs and pull requests: https://github.com/lsst/ap_verify_ci_hits2015/compare/u/kfindeisen/DM-30199.
Krzysztof Findeisen
added a comment - It still treats export.yaml the same in diffs and pull requests: https://github.com/lsst/ap_verify_ci_hits2015/compare/u/kfindeisen/DM-30199 . It turns out I misunderstood what this feature did; an example of the "generated file" filter in action can be found on this Twitch PR. While handy for files that have small diffs, it's basically redundant with how GitHub already displays changes to export.yaml, in that they're hidden but you can explicitly ask for them.
So I'm closing this as Won't Fix and reverting my change to ap_verify_ci_hits2015.
Krzysztof Findeisen
added a comment - It turns out I misunderstood what this feature did; an example of the "generated file" filter in action can be found on this Twitch PR . While handy for files that have small diffs, it's basically redundant with how GitHub already displays changes to export.yaml , in that they're hidden but you can explicitly ask for them.
So I'm closing this as Won't Fix and reverting my change to ap_verify_ci_hits2015 . 
Hmm... testing this change on ap_verify_ci_hits2015 suggests no actual effect: export.yaml shows up as just another very large diff, which was the behavior before.