Merge pull request #1 from reefwing/reefwing-patch-1

Reefwing patch 1

.github/.markdown-link-check.json

@@ -1,4 +1,12 @@
 {
+  "httpHeaders": [
+    {
+      "urls": ["https://docs.github.com/"],
+      "headers": {
+        "Accept-Encoding": "gzip, deflate, br"
+      }
+    }
+  ],
   "retryOn429": true,
   "retryCount": 3,
   "aliveStatusCodes": [200, 206]

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,47 @@
+# Source:
+# https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.md
+# See:
+# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+
+name: Bug report
+description: Report a problem with the code or documentation in this repository.
+labels:
+  - "type: imperfection"
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the problem
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: To reproduce
+      description: Provide the specific set of steps we can follow to reproduce the problem.
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: What would you expect to happen after following those instructions?
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any additional information here.
+    validations:
+      required: false
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Issue checklist
+      description: Please double-check that you have done each of the following things before submitting the issue.
+      options:
+        - label: I searched for previous reports in [the issue tracker](https://github.com/arduino/library-registry/issues?q=)
+          required: true
+        - label: My report contains all necessary details
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,33 @@
+# Source:
+# https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/template-choosers/general/config.yml
+# See:
+# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+
+contact_links:
+  - name: Submit a library
+    url: https://github.com/arduino/library-registry#adding-a-library-to-library-manager
+    about: Instructions for submitting a library for inclusion in the Arduino Library Manager.
+  - name: Change the library URL
+    url: https://github.com/arduino/library-registry#changing-the-url-of-a-library-already-in-library-manager
+    about: Instructions for updating a library's registered URL.
+  - name: Library removal
+    url: https://github.com/arduino/library-registry#removing-a-library-from-library-manager
+    about: Instructions for requesting removal of your library from the Arduino Library Manager index.
+  - name: Submissions of new library releases
+    url: https://github.com/arduino/library-registry/blob/main/FAQ.md#how-can-i-publish-a-new-release-once-my-library-is-in-the-list
+    about: Instructions for publishing a new release of your library.
+  - name: Library not updated after release
+    url: https://github.com/arduino/library-registry/blob/main/FAQ.md#why-arent-releases-of-my-library-being-picked-up-by-library-manager
+    about: Information on why library releases are not picked up.
+  - name: Learn about using the Arduino Library Manager
+    url: https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries/#using-the-library-manager
+    about: Documentation is available here.
+  - name: Learn about using this project
+    url: https://github.com/arduino/library-registry#readme
+    about: Detailed usage documentation is available here.
+  - name: Support request
+    url: https://forum.arduino.cc/
+    about: We can help you out on the Arduino Forum!
+  - name: Discuss development work on the project
+    url: https://groups.google.com/a/arduino.cc/g/developers
+    about: Arduino Developers Mailing List

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,42 @@
+# Source:
+# https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.md
+# See:
+# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+
+name: Feature request
+description: Suggest an enhancement to this project.
+labels:
+  - "type: enhancement"
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the request
+    validations:
+      required: true
+  - type: textarea
+    id: current
+    attributes:
+      label: Describe the current behavior
+      description: |
+        What is the current behavior of the Arduino Library Manager registry in relation to your request?
+        How can we reproduce that behavior?
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any additional information here.
+    validations:
+      required: false
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Issue checklist
+      description: Please double-check that you have done each of the following things before submitting the issue.
+      options:
+        - label: I searched for previous requests in [the issue tracker](https://github.com/arduino/library-registry/issues?q=)
+          required: true
+        - label: My request contains all necessary details
+          required: true

.github/ISSUE_TEMPLATE/release-removal.yml

@@ -0,0 +1,25 @@
+# See:
+# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+
+name: Library release removal
+description: Request the removal of a library release.
+title: Library release removal request
+labels:
+  - "topic: release removal"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please read the instructions for removing a library release: [here](https://github.com/arduino/library-registry/blob/main/FAQ.md#how-can-i-remove-a-release-of-my-library-from-library-manager).
+  - type: input
+    id: name
+    attributes:
+      label: Library name
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version to remove
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/rename.yml

@@ -0,0 +1,19 @@
+# See:
+# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+
+name: Library name change
+description: Request an update of the registered library name.
+title: Library name change request
+labels:
+  - "topic: rename"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please read the instructions for renaming your library: [here](https://github.com/arduino/library-registry/blob/main/FAQ.md#how-can-i-change-a-librarys-name).
+  - type: input
+    id: url
+    attributes:
+      label: Library repository URL
+    validations:
+      required: true

.github/label-configuration-files/labels.yml

@@ -0,0 +1,41 @@
+# Used by the "Sync Labels" workflow
+# See: https://github.com/Financial-Times/github-label-sync#label-config-file
+
+- name: "status: maintenance required"
+  color: "ff0000"
+  description: Infrastructure failure unrelated to request
+- name: "status: pending backend"
+  color: "0000ff"
+  description: Depends on backend maintenance operations
+- name: "topic: invalid"
+  color: "ff0000"
+  description: Request could not be processed
+- name: "topic: modification"
+  color: "00ffff"
+  description: Change existing list entry
+- name: "topic: other"
+  color: "00ffff"
+  description: Something other than a library list request
+- name: "topic: release removal"
+  color: "00ffff"
+  description: Remove a library release
+- name: "topic: removal"
+  color: "00ffff"
+  description: Remove library from the list
+- 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
+- name: "topic: submission"
+  color: "00ffff"
+  description: Add library to the list
+- name: "topic: type change"
+  color: "00ffff"
+  description: Change library types data
+- name: "topic: URL change"
+  color: "00ffff"
+  description: Change library repository URL

.github/workflows/check-license.yml

@@ -34,7 +34,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install Ruby
         uses: ruby/setup-ruby@v1

.github/workflows/check-markdown.yml

@@ -34,10 +34,10 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Initialize markdownlint-cli problem matcher
-        uses: xt0rted/markdownlint-problem-matcher@v1
+        uses: xt0rted/markdownlint-problem-matcher@v2
 
       - name: Install markdownlint-cli
         run: sudo npm install --global markdownlint-cli
@@ -50,7 +50,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Determine whether only modified files should be checked
         id: check-modified

.github/workflows/check-prettier-formatting.yml

@@ -212,7 +212,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install Prettier
         run: sudo npm install --global prettier

.github/workflows/check-toc.yml

@@ -33,7 +33,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install markdown-toc
         run: sudo npm install --global markdown-toc

.github/workflows/check-workflows.yml

@@ -22,11 +22,11 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Download JSON schema for GitHub Actions workflows
         id: download-schema
-        uses: carlosperate/download-file-action@v1.0.3
+        uses: carlosperate/download-file-action@v2
         with:
           # See: https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/github-workflow.json
           file-url: https://json.schemastore.org/github-workflow

.github/workflows/check-yaml.yml

@@ -67,7 +67,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Check YAML
         continue-on-error: ${{ matrix.configuration.continue-on-error }}