You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update format of dependency license metadata (#267)
The "Licensed" tool is used to check for incompatible licenses in the project dependencies. The tool relies on a cache
of metadata stored in the repository.
An older version of "Licensed" was in use at the time the cache was established. There are some minor differences in the
format of the metadata generated by the version of "Licensed" currently in use:
Trailing Whitespace
-------------------
Previous versions of this tool added a trailing
space on the `summary` key. Although trailing whitespace in human produced content is not permitted, machine generated
content is used as-is, and so these trailing spaces were left in the metadata files.
It seems that the defect in the "Licensed" tool that caused the trailing space was fixed in a recent version because it
is now absent in the metadata files produced by the tool.
YAML Document End Markers
-------------------------
The version of the tool now in use adds YAML
document end markers to some metadata files, which were not present in the files generated by the tool at the time the
cache was established.
I don't know why it adds these markers to only some of the metadata files, but they are valid (though optional so the
files without are also correct) and machine generated content is used as-is.
---
Even though there is no technical significance to the format differences, they are disruptive in that they result in
irrelevant diffs in specific metadata files when they are regenerated after a dependency bump. Rather than dealing with
these diffs over time, it will be best to instead update the metadata to the new format comprehensively.
0 commit comments