arduino/library-registry
1
0
Fork 0
mirror of https://github.com/arduino/library-registry.git synced 2025-07-07 14:41:10 +03:00
Code Activity

Remove notes field from label configuration file

Browse Source 
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.
This commit is contained in:
per1234
2022-03-31 01:34:20 -07:00
committed by GitHub
parent f686b8ef92
commit c1ff2b807c
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.github/label-configuration-files/labels.yml vendored
View File

@ -25,12 +25,11 @@
- name: "topic: rename" - name: "topic: rename"
color: "00ffff" color: "00ffff"
description: Change registered library name 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" - name: "topic: security"
color: "ff0000" color: "ff0000"
description: Related to the protection of user data 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" - name: "topic: submission"
color: "00ffff" color: "00ffff"
description: Add library to the list description: Add library to the list