Skip to content

Commit 4dcd572

Browse files
GitshaoxiangGitshaoxiang
authored
Merge pull request arduino#2 from arduino/main
update
2 parents deb5902 + 02deffa commit 4dcd572

22 files changed

+5256
-2741
lines changed

‎.github/.markdown-link-check.json

+8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
{
2+
"httpHeaders": [
3+
{
4+
"urls": ["https://docs.github.com/"],
5+
"headers": {
6+
"Accept-Encoding": "gzip, deflate, br"
7+
}
8+
}
9+
],
210
"retryOn429": true,
311
"retryCount": 3,
412
"aliveStatusCodes": [200, 206]

‎.github/.markdownlint.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown/.markdownlint.yml
12
# See: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
23
# The code style defined in this file is the official standardized style to be used in all Arduino projects and should
34
# not be modified.

‎.github/.yamllint.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-yaml/.yamllint.yml
12
# See: https://yamllint.readthedocs.io/en/stable/configuration.html
2-
# The code style defined in this file is the official standardized style to be used in all Arduino projects and should
3-
# not be modified.
3+
# The code style defined in this file is the official standardized style to be used in all Arduino tooling projects and
4+
# should not be modified.
45
# Note: Rules disabled solely because they are redundant to Prettier are marked with a "Prettier" comment.
56

67
rules:

‎.github/ISSUE_TEMPLATE/bug-report.yml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Source:
2+
# https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.md
3+
# See:
4+
# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
5+
6+
name: Bug report
7+
description: Report a problem with the code or documentation in this repository.
8+
labels:
9+
- "type: imperfection"
10+
body:
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe the problem
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: reproduce
19+
attributes:
20+
label: To reproduce
21+
description: Provide the specific set of steps we can follow to reproduce the problem.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: expected
26+
attributes:
27+
label: Expected behavior
28+
description: What would you expect to happen after following those instructions?
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: additional
33+
attributes:
34+
label: Additional context
35+
description: Add any additional information here.
36+
validations:
37+
required: false
38+
- type: checkboxes
39+
id: checklist
40+
attributes:
41+
label: Issue checklist
42+
description: Please double-check that you have done each of the following things before submitting the issue.
43+
options:
44+
- label: I searched for previous reports in [the issue tracker](https://github.com/arduino/library-registry/issues?q=)
45+
required: true
46+
- label: My report contains all necessary details
47+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Source:
2+
# https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/template-choosers/general/config.yml
3+
# See:
4+
# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
5+
6+
contact_links:
7+
- name: Submit a library
8+
url: https://github.com/arduino/library-registry#adding-a-library-to-library-manager
9+
about: Instructions for submitting a library for inclusion in the Arduino Library Manager.
10+
- name: Change the library URL
11+
url: https://github.com/arduino/library-registry#changing-the-url-of-a-library-already-in-library-manager
12+
about: Instructions for updating a library's registered URL.
13+
- name: Library removal
14+
url: https://github.com/arduino/library-registry#removing-a-library-from-library-manager
15+
about: Instructions for requesting removal of your library from the Arduino Library Manager index.
16+
- name: Submissions of new library releases
17+
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
18+
about: Instructions for publishing a new release of your library.
19+
- name: Library not updated after release
20+
url: https://github.com/arduino/library-registry/blob/main/FAQ.md#why-arent-releases-of-my-library-being-picked-up-by-library-manager
21+
about: Information on why library releases are not picked up.
22+
- name: Learn about using the Arduino Library Manager
23+
url: https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries/#using-the-library-manager
24+
about: Documentation is available here.
25+
- name: Learn about using this project
26+
url: https://github.com/arduino/library-registry#readme
27+
about: Detailed usage documentation is available here.
28+
- name: Support request
29+
url: https://forum.arduino.cc/
30+
about: We can help you out on the Arduino Forum!
31+
- name: Discuss development work on the project
32+
url: https://groups.google.com/a/arduino.cc/g/developers
33+
about: Arduino Developers Mailing List

‎.github/ISSUE_TEMPLATE/feature-request.yml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Source:
2+
# https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.md
3+
# See:
4+
# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
5+
6+
name: Feature request
7+
description: Suggest an enhancement to this project.
8+
labels:
9+
- "type: enhancement"
10+
body:
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe the request
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: current
19+
attributes:
20+
label: Describe the current behavior
21+
description: |
22+
What is the current behavior of the Arduino Library Manager registry in relation to your request?
23+
How can we reproduce that behavior?
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: additional
28+
attributes:
29+
label: Additional context
30+
description: Add any additional information here.
31+
validations:
32+
required: false
33+
- type: checkboxes
34+
id: checklist
35+
attributes:
36+
label: Issue checklist
37+
description: Please double-check that you have done each of the following things before submitting the issue.
38+
options:
39+
- label: I searched for previous requests in [the issue tracker](https://github.com/arduino/library-registry/issues?q=)
40+
required: true
41+
- label: My request contains all necessary details
42+
required: true

‎.github/ISSUE_TEMPLATE/release-removal.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# See:
2+
# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
3+
4+
name: Library release removal
5+
description: Request the removal of a library release.
6+
title: Library release removal request
7+
labels:
8+
- "topic: release removal"
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
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).
14+
- type: input
15+
id: name
16+
attributes:
17+
label: Library name
18+
validations:
19+
required: true
20+
- type: input
21+
id: version
22+
attributes:
23+
label: Version to remove
24+
validations:
25+
required: true

‎.github/ISSUE_TEMPLATE/rename.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# See:
2+
# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
3+
4+
name: Library name change
5+
description: Request an update of the registered library name.
6+
title: Library name change request
7+
labels:
8+
- "topic: rename"
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
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).
14+
- type: input
15+
id: url
16+
attributes:
17+
label: Library repository URL
18+
validations:
19+
required: true

‎.github/dependabot.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file
1+
# See: https://docs.github.com/en/code-security/supply-chain-security/configuration-options-for-dependency-updates#about-the-dependabotyml-file
22
version: 2
33

44
updates:
55
# Configure check for outdated GitHub Actions actions in workflows.
6-
# See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot
6+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/dependabot/README.md
7+
# See: https://docs.github.com/en/code-security/supply-chain-security/keeping-your-actions-up-to-date-with-dependabot
78
- package-ecosystem: github-actions
89
directory: / # Check the repository's workflows under /.github/workflows/
910
schedule:

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

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Used by the "Sync Labels" workflow
2+
# See: https://github.com/Financial-Times/github-label-sync#label-config-file
3+
4+
- name: "status: maintenance required"
5+
color: "ff0000"
6+
description: Infrastructure failure unrelated to request
7+
- name: "status: pending backend"
8+
color: "0000ff"
9+
description: Depends on backend maintenance operations
10+
- name: "topic: invalid"
11+
color: "ff0000"
12+
description: Request could not be processed
13+
- name: "topic: modification"
14+
color: "00ffff"
15+
description: Change existing list entry
16+
- name: "topic: other"
17+
color: "00ffff"
18+
description: Something other than a library list request
19+
- name: "topic: release removal"
20+
color: "00ffff"
21+
description: Remove a library release
22+
- name: "topic: removal"
23+
color: "00ffff"
24+
description: Remove library from the list
25+
- name: "topic: rename"
26+
color: "00ffff"
27+
description: Change registered library name
28+
# Vulnerability disclosures are made following the procedure at:
29+
# https://github.com/arduino/.github/blob/master/SECURITY.md
30+
- name: "topic: security"
31+
color: "ff0000"
32+
description: Related to the protection of user data
33+
- name: "topic: submission"
34+
color: "00ffff"
35+
description: Add library to the list
36+
- name: "topic: type change"
37+
color: "00ffff"
38+
description: Change library types data
39+
- name: "topic: URL change"
40+
color: "00ffff"
41+
description: Change library repository URL

‎.github/workflows/check-license.yml

+21-15
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
name: Check license
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-license.md
2+
name: Check License
23

34
env:
45
EXPECTED_LICENSE_FILENAME: LICENSE.txt
56
# SPDX identifier: https://spdx.org/licenses/
67
EXPECTED_LICENSE_TYPE: CC0-1.0
78

9+
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
810
on:
911
push:
1012
paths:
11-
- ".github/workflows/check-license.yml"
12-
# Recognized license files.
13+
- ".github/workflows/check-license.ya?ml"
1314
# See: https://github.com/licensee/licensee/blob/master/docs/what-we-look-at.md#detecting-the-license-file
1415
- "[cC][oO][pP][yY][iI][nN][gG]*"
1516
- "[cC][oO][pP][yY][rR][iI][gG][hH][tH]*"
@@ -18,44 +19,49 @@ on:
1819
- "[pP][aA][tT][eE][nN][tT][sS]*"
1920
pull_request:
2021
paths:
21-
- ".github/workflows/check-license.yml"
22+
- ".github/workflows/check-license.ya?ml"
2223
- "[cC][oO][pP][yY][iI][nN][gG]*"
2324
- "[cC][oO][pP][yY][rR][iI][gG][hH][tH]*"
2425
- "[lL][iI][cC][eE][nN][cCsS][eE]*"
2526
- "[oO][fF][lL]*"
2627
- "[pP][aA][tT][eE][nN][tT][sS]*"
28+
workflow_dispatch:
29+
repository_dispatch:
2730

2831
jobs:
29-
check:
32+
check-license:
3033
runs-on: ubuntu-latest
3134

3235
steps:
33-
- name: Checkout local repository
34-
uses: actions/checkout@v2
36+
- name: Checkout repository
37+
uses: actions/checkout@v3
3538

36-
- uses: ruby/setup-ruby@v1
39+
- name: Install Ruby
40+
uses: ruby/setup-ruby@v1
3741
with:
3842
ruby-version: ruby # Install latest version
3943

4044
- name: Install licensee
4145
run: gem install licensee
4246

43-
# See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/licensing-a-repository
4447
- name: Check license file
4548
run: |
49+
EXIT_STATUS=0
4650
# See: https://github.com/licensee/licensee
4751
LICENSEE_OUTPUT="$(licensee detect --json --confidence=100)"
4852
4953
DETECTED_LICENSE_FILE="$(echo "$LICENSEE_OUTPUT" | jq .matched_files[0].filename | tr --delete '\r')"
5054
echo "Detected license file: $DETECTED_LICENSE_FILE"
51-
if [ "$DETECTED_LICENSE_FILE" != "\"$EXPECTED_LICENSE_FILENAME\"" ]; then
52-
echo "ERROR: detected license file doesn't match expected: $EXPECTED_LICENSE_FILENAME"
53-
exit 1
55+
if [ "$DETECTED_LICENSE_FILE" != "\"${EXPECTED_LICENSE_FILENAME}\"" ]; then
56+
echo "::error file=${DETECTED_LICENSE_FILE}::detected license file $DETECTED_LICENSE_FILE doesn't match expected: $EXPECTED_LICENSE_FILENAME"
57+
EXIT_STATUS=1
5458
fi
5559
5660
DETECTED_LICENSE_TYPE="$(echo "$LICENSEE_OUTPUT" | jq .matched_files[0].matched_license | tr --delete '\r')"
5761
echo "Detected license type: $DETECTED_LICENSE_TYPE"
58-
if [ "$DETECTED_LICENSE_TYPE" != "\"$EXPECTED_LICENSE_TYPE\"" ]; then
59-
echo "ERROR: detected license type doesn't match expected $EXPECTED_LICENSE_TYPE"
60-
exit 1
62+
if [ "$DETECTED_LICENSE_TYPE" != "\"${EXPECTED_LICENSE_TYPE}\"" ]; then
63+
echo "::error file=${DETECTED_LICENSE_FILE}::detected license type $DETECTED_LICENSE_TYPE doesn't match expected \"${EXPECTED_LICENSE_TYPE}\""
64+
EXIT_STATUS=1
6165
fi
66+
67+
exit $EXIT_STATUS

‎.github/workflows/check-markdown.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ jobs:
3434

3535
steps:
3636
- name: Checkout repository
37-
uses: actions/checkout@v2
37+
uses: actions/checkout@v3
3838

3939
- name: Initialize markdownlint-cli problem matcher
40-
uses: xt0rted/markdownlint-problem-matcher@v1
40+
uses: xt0rted/markdownlint-problem-matcher@v2
4141

4242
- name: Install markdownlint-cli
4343
run: sudo npm install --global markdownlint-cli
@@ -50,7 +50,7 @@ jobs:
5050

5151
steps:
5252
- name: Checkout repository
53-
uses: actions/checkout@v2
53+
uses: actions/checkout@v3
5454

5555
- name: Determine whether only modified files should be checked
5656
id: check-modified

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ jobs:
212212

213213
steps:
214214
- name: Checkout repository
215-
uses: actions/checkout@v2
215+
uses: actions/checkout@v3
216216

217217
- name: Install Prettier
218218
run: sudo npm install --global prettier

‎.github/workflows/check-toc.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333

3434
steps:
3535
- name: Checkout repository
36-
uses: actions/checkout@v2
36+
uses: actions/checkout@v3
3737

3838
- name: Install markdown-toc
3939
run: sudo npm install --global markdown-toc

‎.github/workflows/check-workflows.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ jobs:
2222

2323
steps:
2424
- name: Checkout repository
25-
uses: actions/checkout@v2
25+
uses: actions/checkout@v3
2626

2727
- name: Download JSON schema for GitHub Actions workflows
2828
id: download-schema
29-
uses: carlosperate/download-file-action@v1.0.3
29+
uses: carlosperate/download-file-action@v2
3030
with:
3131
# See: https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/github-workflow.json
3232
file-url: https://json.schemastore.org/github-workflow

‎.github/workflows/check-yaml.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ jobs:
6767

6868
steps:
6969
- name: Checkout repository
70-
uses: actions/checkout@v2
70+
uses: actions/checkout@v3
7171

7272
- name: Check YAML
7373
continue-on-error: ${{ matrix.configuration.continue-on-error }}

0 commit comments

Comments
 (0)