arduino/library-registry
1
0
Fork 0
mirror of https://github.com/arduino/library-registry.git synced 2025-11-17 05:22:37 +03:00
Code Activity

Merge pull request #1185 from per1234/update-links

Browse Source 
Improve and correct links in documentation
This commit is contained in:
per1234
2022-03-14 02:56:09 -07:00
committed by GitHub
parent cfe1dc7e12 dd55ef3d71
commit d29272cde3
3 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.github/workflows/manage-prs.yml vendored
View File

@@ -13,7 +13,7 @@ on:
# comment and merge. # 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 # 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. # 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/actions/reference/events-that-trigger-workflows#pull_request_target
pull_request_target: pull_request_target:
types: types:
- opened - opened
@@ -61,7 +61,7 @@ jobs:
head: ${{ steps.head.outputs.head }} head: ${{ steps.head.outputs.head }}
env: env:
# See: https://docs.github.com/en/rest/reference/pulls#custom-media-types-for-pull-requests # See: https://docs.github.com/rest/reference/pulls#custom-media-types-for-pull-requests
DIFF_IDENTIFIER: diff DIFF_IDENTIFIER: diff
JSON_IDENTIFIER: raw+json JSON_IDENTIFIER: raw+json
@@ -535,7 +535,7 @@ jobs:
${{ env.ERROR_MESSAGE_PREFIX }}Your submission meets all requirements. However, the pull request could not be merged. ${{ env.ERROR_MESSAGE_PREFIX }}Your submission meets all requirements. However, the pull request could not be merged.
Please follow this guide to sync your fork: Please follow this guide to sync your fork:
https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/syncing-a-fork https://docs.github.com/github/collaborating-with-pull-requests/working-with-forks/syncing-a-fork
Once that is done, it will be merged automatically. Once that is done, it will be merged automatically.
@@ -554,7 +554,7 @@ jobs:
${{ env.ERROR_MESSAGE_PREFIX }}Your submission meets all requirements. However, the pull request could not be merged. ${{ env.ERROR_MESSAGE_PREFIX }}Your submission meets all requirements. However, the pull request could not be merged.
Please follow this guide to resolve a merge conflict: Please follow this guide to resolve a merge conflict:
https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github https://docs.github.com/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github
Once that is done, it will be merged automatically. Once that is done, it will be merged automatically.

8
FAQ.md
View File

@@ -43,7 +43,7 @@ When a library is [added to the library list](README.md#adding-a-library-to-libr
More information: More information:
- https://www.arduino.cc/en/Guide/Libraries#toc3 - https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries#using-the-library-manager
- https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_lib/ - https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_lib/
- https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-on-various-platforms-4b3e4a - https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-on-various-platforms-4b3e4a
@@ -77,9 +77,9 @@ Follow the instructions [here](README.md#adding-a-library-to-library-manager).
- [ ] For 3rd party libraries, the `name` field in library.properties must not start with `Arduino`. - [ ] For 3rd party libraries, the `name` field in library.properties must not start with `Arduino`.
- [ ] The library repository must not contain any `.exe` files. - [ ] The library repository must not contain any `.exe` files.
- [ ] The library repository must not contain a [`.development` file](https://arduino.github.io/arduino-cli/latest/library-specification/#development-flag-file). - [ ] The library repository must not contain a [`.development` file](https://arduino.github.io/arduino-cli/latest/library-specification/#development-flag-file).
- [ ] The library repository must not contain any [symlinks](https://en.wikipedia.org/wiki/Symbolic_link). - [ ] The library repository must not contain any [symlinks](https://wikipedia.org/wiki/Symbolic_link).
- [ ] The library repository must not contain any files detected as infected by our antivirus scan. - [ ] The library repository must not contain any files detected as infected by our antivirus scan.
- [ ] The library repository must have a [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) (or [release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository)) and must have been compliant with all the above requirements at the time of that tag. - [ ] The library repository must have a [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) (or [release](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository)) and must have been compliant with all the above requirements at the time of that tag.
- [ ] The library repository must be hosted on a major Git-hosting website like GitHub, BitBucket or GitLab (other hosting sites may be considered on request). - [ ] The library repository must be hosted on a major Git-hosting website like GitHub, BitBucket or GitLab (other hosting sites may be considered on request).
Arduino has created a command line tool to check libraries for compliance with all the Library Manager requirements: Arduino has created a command line tool to check libraries for compliance with all the Library Manager requirements:
@@ -102,7 +102,7 @@ Note that libraries will need to be compliant with [all requirements](#update-re
1. Make sure the library is compliant with [all requirements](#update-requirements). 1. Make sure the library is compliant with [all requirements](#update-requirements).
1. Update the `version` in the library's [`library.properties`](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata)). 1. Update the `version` in the library's [`library.properties`](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata)).
1. Tag the library's repository once more and push the new tag (or create a release if the library's Git-hosting site offers a way to do it, for example with [GitHub "releases"](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository)). 1. Tag the library's repository once more and push the new tag (or create a release if the library's Git-hosting site offers a way to do it, for example with [GitHub "releases"](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository)).
[Our indexer](#how-is-the-library-manager-index-generated) checks for new releases every hour and will eventually fetch and publish the new release. [Our indexer](#how-is-the-library-manager-index-generated) checks for new releases every hour and will eventually fetch and publish the new release.

8
README.md
View File

@@ -1,7 +1,7 @@
# Arduino Library Manager list # Arduino Library Manager list
This repository contains the list of libraries in the This repository contains the list of libraries in the
[Arduino Library Manager](https://www.arduino.cc/en/guide/libraries#toc3) index. [Arduino Library Manager](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries#using-the-library-manager) index.
## Table of Contents ## Table of Contents
@@ -25,7 +25,7 @@ For more information about Arduino Library Manager and how the index is maintain
## Adding a library to Library Manager ## Adding a library to Library Manager
If you would like to make a library available for installation via Library Manager, just submit a If you would like to make a library available for installation via Library Manager, just submit a
[pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests) [pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests)
that adds the repository URL to [the list](repositories.txt). You are welcome to add multiple libraries at once. that adds the repository URL to [the list](repositories.txt). You are welcome to add multiple libraries at once.
See the instructions below for detailed instructions on how to do this via the GitHub web interface. See the instructions below for detailed instructions on how to do this via the GitHub web interface.
@@ -54,7 +54,7 @@ with your pull request or with the library.
#### If the problem is with the pull request: #### If the problem is with the pull request:
Edit the file in the Edit the file in the
[branch](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) [branch](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)
you submitted the pull request from in your fork of the `arduino/library-registry` repository, then commit. you submitted the pull request from in your fork of the `arduino/library-registry` repository, then commit.
Doing this will update the pull request and cause the automated checks to run again. Doing this will update the pull request and cause the automated checks to run again.
@@ -65,7 +65,7 @@ Doing this will update the pull request and cause the automated checks to run ag
1. Increment the `version` value in the library's 1. Increment the `version` value in the library's
[library.properties file](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata). [library.properties file](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata).
1. Create a 1. Create a
[release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository) [release](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
or [tag](https://git-scm.com/docs/git-tag). The Library Manager index always uses tagged versions of the libraries, or [tag](https://git-scm.com/docs/git-tag). The Library Manager index always uses tagged versions of the libraries,
so even if the development version of the library is compliant, it can't be accepted until the latest release or tag so even if the development version of the library is compliant, it can't be accepted until the latest release or tag
is compliant. Alternatively, you can redo the existing release/tag if you prefer. is compliant. Alternatively, you can redo the existing release/tag if you prefer.