[DAMD-90] Record file format versions Created: 19/Sep/20 Updated: 11/Mar/21 Resolved: 11/Mar/21 |
|
| Status: | Done |
| Project: | Data Model |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Story | Priority: | Normal |
| Reporter: | price | Assignee: | price |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Story Points: | 4 |
| Sprint: | 2DDRP-2021 A 2, 2DDRP-2021 A3 |
| Reviewers: | hassan |
| Description |
|
If we do not record file format versions in the headers, we are sure to regret it later. I propose the file format version be an integer value recorded in the header keyword DAMD_VER in the primary header of every FITS file format documented in datamodel.txt. The version will be particular to the type of file (not a global value for all types of files). |
| Comments |
| Comment by rhl [ 19/Sep/20 ] |
|
An integer is a lot better than nothing, but doesn't help figure out what changed. Maybe we could have a file in datamodel.txt to be updated with a helpful comment associated with each bumped version number, or something like that? |
| Comment by price [ 19/Sep/20 ] |
|
I was planning to record the version numbers in datamodel.txt, and then you could always look at the file history with git if you wanted to figure out an old format. But having a separate file recording the changes is a good idea too. |
| Comment by price [ 06/Mar/21 ] |
|
Added DAMD_VER headers, and versions.txt to document the different version numbers. |
| Comment by price [ 11/Mar/21 ] |
|
Merged to master. |