SpenceKonde / megaTinyCore

Arduino core for the tinyAVR 0/1/2-series - Ones's digit 2,4,5,7 (pincount, 8,14,20,24), tens digit 0, 1, or 2 (featureset), preceded by flash in kb. Library maintainers: porting help available!
Other
554 stars 144 forks source link

Update redirecting URLs in bundled library metadata #987

Closed per1234 closed 1 year ago

per1234 commented 1 year ago

The url field of the library.properties metadata file points the user to where they might find more information or assistance for the library.

This platform includes bundled libraries which are variants of the standardized libraries distributed by Arduino. The url field in the metadata of these libraries points to the reference on the arduino.cc website, as that information is also applicable to this platform's variants of the libraries.

Due to restructuring of the arduino.cc website, the targeted reference pages have moved to a different URL. Arduino set up redirects from the previous URLs to the new one, but redirects have a tendency to break or no longer lead to the intended target over time so it is best to avoid relying on them. In addition, the use of redirecting URLs seems to make it more likely that automated link checks will fail (https://github.com/per1234/arduino-ci-script/issues/33) due to an HTTP 403 ("Forbidden") response code:

https://github.com/SpenceKonde/megaTinyCore/actions/runs/5515842517/jobs/10056585694#step:4:9

ERROR: /home/runner/work/megaTinyCore/megaTinyCore/megaavr/libraries/EEPROM/library.properties: url value http://www.arduino.cc/en/Reference/EEPROM returned error status 403.
ERROR: /home/runner/work/megaTinyCore/megaTinyCore/megaavr/libraries/SD/library.properties: url value http://www.arduino.cc/en/Reference/SD returned error status 403.
ERROR: /home/runner/work/megaTinyCore/megaTinyCore/megaavr/libraries/SPI/library.properties: url value http://www.arduino.cc/en/Reference/SPI returned error status 403.
ERROR: /home/runner/work/megaTinyCore/megaTinyCore/megaavr/libraries/Servo/library.properties: url value http://www.arduino.cc/en/Reference/Servo returned error status 403.
ERROR: /home/runner/work/megaTinyCore/megaTinyCore/megaavr/libraries/Servo_megaTinyCore/library.properties: url value http://www.arduino.cc/en/Reference/Servo returned error status 403.
ERROR: /home/runner/work/megaTinyCore/megaTinyCore/megaavr/libraries/SoftwareSerial/library.properties: url value http://www.arduino.cc/en/Reference/SoftwareSerial returned error status 403.
ERROR: /home/runner/work/megaTinyCore/megaTinyCore/megaavr/libraries/USERSIG/library.properties: url value http://www.arduino.cc/en/Reference/EEPROM returned error status 403.
ERROR: /home/runner/work/megaTinyCore/megaTinyCore/megaavr/libraries/Wire/library.properties: url value http://www.arduino.cc/en/Reference/Wire returned error status 403.

even though the URL does work as expected when a human loads it in their browser:

SpenceKonde commented 1 year ago

Thanks!

per1234 commented 1 year ago

@SpenceKonde did you intend to merge this instead of closing?