You've already forked library-registry
mirror of
https://github.com/arduino/library-registry.git
synced 2025-07-05 21:21:14 +03:00
Reduce excessive line lengths in YAML files
The yamllint configuration advocates for keeping line lengths within 120 characters. While exceeding this length only results in a warning, I think it is beneficial to stay within that limit when it is possible and doesn't have a harmful effect. In that spirit, I have reduced the long lines where this was easily done. There remain a few that are either not possible or else not reasonable to reduce, and that's OK.
This commit is contained in:
3
.github/workflows/check-license.yml
vendored
3
.github/workflows/check-license.yml
vendored
@ -9,7 +9,8 @@ on:
|
|||||||
push:
|
push:
|
||||||
paths:
|
paths:
|
||||||
- ".github/workflows/check-license.yml"
|
- ".github/workflows/check-license.yml"
|
||||||
# Recognized license files. See: https://github.com/licensee/licensee/blob/master/docs/what-we-look-at.md#detecting-the-license-file
|
# Recognized license files.
|
||||||
|
# See: https://github.com/licensee/licensee/blob/master/docs/what-we-look-at.md#detecting-the-license-file
|
||||||
- "[cC][oO][pP][yY][iI][nN][gG]*"
|
- "[cC][oO][pP][yY][iI][nN][gG]*"
|
||||||
- "[cC][oO][pP][yY][rR][iI][gG][hH][tH]*"
|
- "[cC][oO][pP][yY][rR][iI][gG][hH][tH]*"
|
||||||
- "[lL][iI][cC][eE][nN][cCsS][eE]*"
|
- "[lL][iI][cC][eE][nN][cCsS][eE]*"
|
||||||
|
7
.github/workflows/check-toc.yml
vendored
7
.github/workflows/check-toc.yml
vendored
@ -39,7 +39,12 @@ jobs:
|
|||||||
run: sudo npm install --global markdown-toc
|
run: sudo npm install --global markdown-toc
|
||||||
|
|
||||||
- name: Rebuild ToC
|
- name: Rebuild ToC
|
||||||
run: markdown-toc --bullets=- --maxdepth=${{ matrix.file.maxdepth }} -i "${{ github.workspace }}/${{ matrix.file.name }}"
|
run: |
|
||||||
|
markdown-toc \
|
||||||
|
--bullets=- \
|
||||||
|
--maxdepth=${{ matrix.file.maxdepth }} \
|
||||||
|
-i \
|
||||||
|
"${{ github.workspace }}/${{ matrix.file.name }}"
|
||||||
|
|
||||||
- name: Check ToC
|
- name: Check ToC
|
||||||
run: git diff --color --exit-code
|
run: git diff --color --exit-code
|
||||||
|
46
.github/workflows/manage-prs.yml
vendored
46
.github/workflows/manage-prs.yml
vendored
@ -4,8 +4,10 @@ env:
|
|||||||
SUBMISSION_PARSER_VERSION: 1.0.0-rc2 # See: https://github.com/arduino/library-manager-submission-parser/releases
|
SUBMISSION_PARSER_VERSION: 1.0.0-rc2 # See: https://github.com/arduino/library-manager-submission-parser/releases
|
||||||
|
|
||||||
on:
|
on:
|
||||||
# pull_request_target trigger is used instead of pull_request so the token will have the write permissions needed to comment and merge.
|
# pull_request_target trigger is used instead of pull_request so the token will have the write permissions needed to
|
||||||
# Note that this means the version of the workflow from the PR base ref will be used as opposed to the head ref, as is the case with pull_request triggered workflows.
|
# comment and merge.
|
||||||
|
# Note that this means the version of the workflow from the PR base ref will be used as opposed to the head ref, as is
|
||||||
|
# the case with pull_request triggered workflows.
|
||||||
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target
|
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target
|
||||||
pull_request_target:
|
pull_request_target:
|
||||||
types:
|
types:
|
||||||
@ -53,7 +55,8 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
run: |
|
run: |
|
||||||
# It's necessary to reference both pull_request.number and issue.number because only one of the two are defined depending on whether the workflow is triggered by PR or comment event.
|
# It's necessary to reference both pull_request.number and issue.number because only one of the two are
|
||||||
|
# defined depending on whether the workflow is triggered by PR or comment event.
|
||||||
curl \
|
curl \
|
||||||
--fail \
|
--fail \
|
||||||
--output "${{ steps.configuration.outputs.path }}/${{ steps.configuration.outputs.filename }}" \
|
--output "${{ steps.configuration.outputs.path }}/${{ steps.configuration.outputs.filename }}" \
|
||||||
@ -99,8 +102,14 @@ jobs:
|
|||||||
id: parse-request
|
id: parse-request
|
||||||
run: |
|
run: |
|
||||||
chmod u+x "${{ steps.download-parser.outputs.file-path }}"
|
chmod u+x "${{ steps.download-parser.outputs.file-path }}"
|
||||||
REQUEST="$("${{ steps.download-parser.outputs.file-path }}" --diffpath="${{ needs.diff.outputs.path }}/${{ needs.diff.outputs.filename }}" --repopath="${{ github.workspace }}" --listname="repositories.txt")"
|
REQUEST="$( \
|
||||||
# Due to limitations of the GitHub Actions workflow system, dedicated outputs must be created for use in certain workflow fields.
|
"${{ steps.download-parser.outputs.file-path }}" \
|
||||||
|
--diffpath="${{ needs.diff.outputs.path }}/${{ needs.diff.outputs.filename }}" \
|
||||||
|
--repopath="${{ github.workspace }}" \
|
||||||
|
--listname="repositories.txt" \
|
||||||
|
)"
|
||||||
|
# Due to limitations of the GitHub Actions workflow system, dedicated outputs must be created for use in
|
||||||
|
# certain workflow fields.
|
||||||
echo "::set-output name=type::$(echo "$REQUEST" | jq -r -c '.type')"
|
echo "::set-output name=type::$(echo "$REQUEST" | jq -r -c '.type')"
|
||||||
echo "::set-output name=submissions::$(echo "$REQUEST" | jq -c '.submissions')"
|
echo "::set-output name=submissions::$(echo "$REQUEST" | jq -c '.submissions')"
|
||||||
echo "::set-output name=index-entry::$(echo "$REQUEST" | jq -r -c '.indexEntry')"
|
echo "::set-output name=index-entry::$(echo "$REQUEST" | jq -r -c '.indexEntry')"
|
||||||
@ -149,7 +158,8 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
with:
|
with:
|
||||||
# NOTE: "Unexpected input(s) ..." warnings for the arbitrary octokit/request-action inputs are normal and expected.
|
# NOTE: "Unexpected input(s) ..." warnings for the arbitrary octokit/request-action inputs are normal and
|
||||||
|
# expected.
|
||||||
route: POST /repos/{owner}/{repo}/issues/{issue_number}/comments
|
route: POST /repos/{owner}/{repo}/issues/{issue_number}/comments
|
||||||
owner: ${{ github.repository_owner }}
|
owner: ${{ github.repository_owner }}
|
||||||
repo: ${{ github.event.repository.name }}
|
repo: ${{ github.event.repository.name }}
|
||||||
@ -167,7 +177,11 @@ jobs:
|
|||||||
exit 1
|
exit 1
|
||||||
|
|
||||||
- name: Clone submission
|
- name: Clone submission
|
||||||
run: git clone --branch ${{ matrix.submission.tag }} --depth 1 ${{ matrix.submission.normalizedURL }} "${{ matrix.submission.name }}"
|
run: |
|
||||||
|
git clone \
|
||||||
|
--branch ${{ matrix.submission.tag }} \
|
||||||
|
--depth 1 ${{ matrix.submission.normalizedURL }} \
|
||||||
|
"${{ matrix.submission.name }}"
|
||||||
|
|
||||||
- name: Lint submission
|
- name: Lint submission
|
||||||
id: arduino-lint
|
id: arduino-lint
|
||||||
@ -187,7 +201,9 @@ jobs:
|
|||||||
echo "::set-output name=report::$(jq -c . "${{ env.REPORT_PATH }}")"
|
echo "::set-output name=report::$(jq -c . "${{ env.REPORT_PATH }}")"
|
||||||
|
|
||||||
- name: Comment on Arduino Lint warning
|
- name: Comment on Arduino Lint warning
|
||||||
if: fromJson(steps.read-lint-report.outputs.report).summary.warningCount > 0 && fromJson(steps.read-lint-report.outputs.report).summary.errorCount == 0
|
if: >
|
||||||
|
fromJson(steps.read-lint-report.outputs.report).summary.warningCount > 0
|
||||||
|
&& fromJson(steps.read-lint-report.outputs.report).summary.errorCount == 0
|
||||||
uses: octokit/request-action@v2.x
|
uses: octokit/request-action@v2.x
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
@ -255,7 +271,8 @@ jobs:
|
|||||||
- Commit the required change to the branch you submitted this pull request from.
|
- Commit the required change to the branch you submitted this pull request from.
|
||||||
- Comment here, mentioning @ArduinoBot in the comment
|
- Comment here, mentioning @ArduinoBot in the comment
|
||||||
|
|
||||||
More information: https://github.com/${{ github.repository }}/blob/main/README.md#if-the-problem-is-with-the-pull-request"
|
More information:
|
||||||
|
https://github.com/${{ github.repository }}/blob/main/README.md#if-the-problem-is-with-the-pull-request
|
||||||
|
|
||||||
merge:
|
merge:
|
||||||
needs:
|
needs:
|
||||||
@ -288,7 +305,12 @@ jobs:
|
|||||||
git config --global user.name "ArduinoBot"
|
git config --global user.name "ArduinoBot"
|
||||||
echo "${{ needs.parse.outputs.index-entry }}" >> "$INDEX_SOURCE_FILE_PATH"
|
echo "${{ needs.parse.outputs.index-entry }}" >> "$INDEX_SOURCE_FILE_PATH"
|
||||||
git add --update "$INDEX_SOURCE_FILE_PATH"
|
git add --update "$INDEX_SOURCE_FILE_PATH"
|
||||||
echo -e "Add submission # ${{ github.event.pull_request.number }}${{ github.event.issue.number }}\n\n${{ github.event.repository.html_url }}/pull/${{ github.event.pull_request.number }}${{ github.event.issue.number }}" | git commit --file -
|
echo \
|
||||||
|
-e \
|
||||||
|
"Add submission # ${{ github.event.pull_request.number }}${{ github.event.issue.number }}\n\n${{ github.event.repository.html_url }}/pull/${{ github.event.pull_request.number }}${{ github.event.issue.number }}" \
|
||||||
|
| \
|
||||||
|
git commit \
|
||||||
|
--file -
|
||||||
git push
|
git push
|
||||||
|
|
||||||
request-review:
|
request-review:
|
||||||
@ -322,7 +344,9 @@ jobs:
|
|||||||
issue_number: ${{ github.event.pull_request.number }}${{ github.event.issue.number }}
|
issue_number: ${{ github.event.pull_request.number }}${{ github.event.issue.number }}
|
||||||
body: |
|
body: |
|
||||||
|
|
|
|
||||||
Hi @${{ github.actor }}. Your pull request has been detected as something other than a Library Manager submission. A maintainer will need to review it before it can be merged.
|
Hi @${{ github.actor }}.
|
||||||
|
Your pull request has been detected as something other than a Library Manager submission.
|
||||||
|
A maintainer will need to review it before it can be merged.
|
||||||
|
|
||||||
If you intended to submit a library, please check the instructions and update your pull request if necessary:
|
If you intended to submit a library, please check the instructions and update your pull request if necessary:
|
||||||
https://github.com/${{ github.repository }}/blob/main/README.md#instructions
|
https://github.com/${{ github.repository }}/blob/main/README.md#instructions
|
||||||
|
2
.github/workflows/spell-check.yml
vendored
2
.github/workflows/spell-check.yml
vendored
@ -24,7 +24,7 @@ jobs:
|
|||||||
- name: Spell check
|
- name: Spell check
|
||||||
uses: codespell-project/actions-codespell@master
|
uses: codespell-project/actions-codespell@master
|
||||||
with:
|
with:
|
||||||
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
|
# In the event of false positive, add the problematic word, in all lowercase, to a comma-separated list here:
|
||||||
ignore_words_list: ""
|
ignore_words_list: ""
|
||||||
builtin: clear,informal,en-GB_to_en-US
|
builtin: clear,informal,en-GB_to_en-US
|
||||||
check_filenames: true
|
check_filenames: true
|
||||||
|
Reference in New Issue
Block a user