Skip to content

Commit d98fb50

Browse files
authored
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.
1 parent 3da4924 commit d98fb50

File tree

7 files changed

+9
-7
lines changed

7 files changed

+9
-7
lines changed

Diff for: .licenses/arduino-fwuploader/go/github.com/mattn/go-colorable.dep.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: github.com/mattn/go-colorable
33
version: v0.1.8
44
type: go
5-
summary:
5+
summary:
66
homepage: https://pkg.go.dev/github.com/mattn/go-colorable
77
license: mit
88
licenses:

Diff for: .licenses/arduino-fwuploader/go/go.bug.st/cleanup.dep.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: go.bug.st/cleanup
33
version: v1.0.0
44
type: go
5-
summary:
5+
summary:
66
homepage: https://pkg.go.dev/go.bug.st/cleanup
77
license: bsd-3-clause
88
licenses:
@@ -42,3 +42,4 @@ licenses:
4242
POSSIBILITY OF SUCH DAMAGE.
4343
4444
notices: []
45+
...

Diff for: .licenses/arduino-fwuploader/go/go.bug.st/downloader/v2.dep.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: go.bug.st/downloader/v2
33
version: v2.1.1
44
type: go
5-
summary:
5+
summary:
66
homepage: https://pkg.go.dev/go.bug.st/downloader/v2
77
license: bsd-3-clause
88
licenses:
@@ -42,3 +42,4 @@ licenses:
4242
POSSIBILITY OF SUCH DAMAGE.
4343
4444
notices: []
45+
...

Diff for: .licenses/arduino-fwuploader/go/google.golang.org/protobuf/internal/encoding/json.dep.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: google.golang.org/protobuf/internal/encoding/json
33
version: v1.33.0
44
type: go
5-
summary:
5+
summary:
66
homepage: https://pkg.go.dev/google.golang.org/protobuf/internal/encoding/json
77
license: bsd-3-clause
88
licenses:

Diff for: .licenses/arduino-fwuploader/go/google.golang.org/protobuf/internal/impl.dep.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: google.golang.org/protobuf/internal/impl
33
version: v1.33.0
44
type: go
5-
summary:
5+
summary:
66
homepage: https://pkg.go.dev/google.golang.org/protobuf/internal/impl
77
license: bsd-3-clause
88
licenses:

Diff for: .licenses/arduino-fwuploader/go/google.golang.org/protobuf/types/descriptorpb.dep.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: google.golang.org/protobuf/types/descriptorpb
33
version: v1.33.0
44
type: go
5-
summary:
5+
summary:
66
homepage: https://pkg.go.dev/google.golang.org/protobuf/types/descriptorpb
77
license: bsd-3-clause
88
licenses:

Diff for: .licenses/arduino-fwuploader/go/google.golang.org/protobuf/types/known/wrapperspb.dep.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: google.golang.org/protobuf/types/known/wrapperspb
33
version: v1.33.0
44
type: go
5-
summary:
5+
summary:
66
homepage: https://pkg.go.dev/google.golang.org/protobuf/types/known/wrapperspb
77
license: bsd-3-clause
88
licenses:

0 commit comments

Comments
 (0)