From c1ff2b807cc7ebae7e6247cb169d970997ce6db7 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 31 Mar 2022 01:34:20 -0700 Subject: [PATCH] Remove `notes` field from label configuration file At the time the reference configuration file was developed, it was in JSON, which does not support comments. I found the need to add some internal explanatory commentary to some of the labels, so I added an arbitrary `notes` key as a container for this information, and our JSON schema was also configured to accept this field. I later decided to convert the files to YAML, since that is the language used by the majority of the asset configuration files. At this point it became possible to use comments, but the `notes` field was already in place so it seemed pointless to change it. Validation of the configuration file was added to the "GitHub Label Sync" tool in the recent 2.1.0 release. Before 2.1.0, the tool ignored any additional properties in the label configuration objects. It now errors if there are any unexpected properties. This `notes` field now causes the configuration files that contain it to be considered invalid by the tool, and by our custom JSON schema: ``` .github/label-configuration-files/labels.yml invalid [ { instancePath: '/8', schemaPath: '#/items/additionalProperties', keyword: 'additionalProperties', params: { additionalProperty: 'notes' }, message: 'must NOT have additional properties' } ] ``` So the `notes` field is hereby removed, with the contents moved to comments. --- .github/label-configuration-files/labels.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/label-configuration-files/labels.yml b/.github/label-configuration-files/labels.yml index be49bb3c..53d3f4f9 100644 --- a/.github/label-configuration-files/labels.yml +++ b/.github/label-configuration-files/labels.yml @@ -25,12 +25,11 @@ - name: "topic: rename" color: "00ffff" description: Change registered library name +# Vulnerability disclosures are made following the procedure at: +# https://github.com/arduino/.github/blob/master/SECURITY.md - name: "topic: security" color: "ff0000" description: Related to the protection of user data - notes: | - Vulnerability disclosures are made following the procedure at: - https://github.com/arduino/.github/blob/master/SECURITY.md - name: "topic: submission" color: "00ffff" description: Add library to the list