search

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 #989

Closed per1234 closed 1 year ago

per1234 commented 1 year ago

This is a second submission of https://github.com/SpenceKonde/megaTinyCore/pull/987. I believe that PR was closed in error and I have not been successful in getting it reopened or merged so I submit once again.

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

Hm, what are you saying didn't happen? I thought I got this merged....

Spence Konde Azzy’S Electronics

New products! Check them out at tindie.com/stores/DrAzzy GitHub: github.com/SpenceKonde ATTinyCore: Arduino support for almost every ATTiny microcontroller Contact: @.***

On Sun, Jul 23, 2023, 15:22 per1234 @.***> wrote:

This is a second submission of #987 https://github.com/SpenceKonde/megaTinyCore/pull/987. I believe that PR was closed in error and I have not been successful in getting it reopened or merged so I submit once again.

The url field of the library.properties metadata file https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata points the user to where they might find more information or assistance for the library.

This platform includes bundled libraries https://arduino.github.io/arduino-cli/latest/platform-specification/#platform-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 (per1234/arduino-ci-script#33 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:

You can view, comment on, or merge this pull request online at:

https://github.com/SpenceKonde/megaTinyCore/pull/989 Commit Summary

File Changes

(8 files https://github.com/SpenceKonde/megaTinyCore/pull/989/files)

Patch Links:

— Reply to this email directly, view it on GitHub https://github.com/SpenceKonde/megaTinyCore/pull/989, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABTXEW57EUGML4H35HYNVYTXRV2W5ANCNFSM6AAAAAA2UWI2LQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

per1234 commented 1 year ago

@SpenceKonde you closed the other PR instead of merging it:

https://github.com/SpenceKonde/megaTinyCore/pull/987#event-9869559520

image