diff --git a/.github/workflows/check_links.yml b/.github/workflows/check_links.yml new file mode 100644 index 00000000..e4d8a03d --- /dev/null +++ b/.github/workflows/check_links.yml @@ -0,0 +1,17 @@ +name: Check links + +on: + workflow_dispatch: + push: + branches: + - master + - main + tags: + - '*' + pull_request: + schedule: + - cron: '30 3 * * 5' # Run every Friday at 3:30 AM UTC + +jobs: + linkChecker: + uses: Infineon/makers-devops/.github/workflows/check_links.yml@main \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fb4b239..aaaba7b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Please contribute and raise issues via the [github repository](https://github.co - Start your contribution by creating a [fork](https://github.com/Infineon/XMC-for-Arduino/fork) of this repository. - It's recommended to create a separate branch for your contribution in your fork. -- Once your contribution is ready & tested, please create a [Pull Request](https://github.com/Infineon/XMC-for-Arduino/compare) to the master branch. We have some automated tests, so make sure you've browsed our [CODE CONVENTION](CODE_CONVENTION.md) and [development instructions](https://xmc-arduino.readthedocs.io/en/latest/development-instructions.html) +- Once your contribution is ready & tested, please create a [Pull Request](https://github.com/Infineon/XMC-for-Arduino/compare) to the master branch. We have some automated tests, so make sure you've browsed our [CODE CONVENTIONS](CODE_CONVENTIONS.md) and [development instructions](https://xmc-arduino.readthedocs.io/en/latest/development-instructions.html) - Once we merged your changes to the master branch, they are automatically included in the next release. ## Development diff --git a/README.md b/README.md index e1e993e9..7cbeb6a7 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,10 @@ ![Compilation Status](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/compile-platform-examples.yml/badge.svg) [![Documentation Status](https://readthedocs.org/projects/xmc-arduino/badge/?version=latest)](https://xmc-arduino.readthedocs.io/en/latest/?badge=latest) -[![Hil unity library checks](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/hil_checks.yml/badge.svg)](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/hil_checks.yml) +[![On-target Tests](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/hil_checks.yml/badge.svg)](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/hil_checks.yml) +[![Link Checks](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/check_links.yml/badge.svg)](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/check_links.yml) -This project integrates Infineon's 32-bit XMC™ Industrial Arm® Cortex®-M Microcontroller into the [Arduino](https://www.arduino.cc/en/Guide/Introduction) ecosystem. +This project integrates Infineon's 32-bit XMC™ Industrial Arm® Cortex®-M Microcontroller into the [Arduino](https://www.arduino.cc/) ecosystem. The [XMC™ microcontroller family](https://www.infineon.com/cms/de/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/) from Infineon is a powerful and versatile platform for embedded system development. The XMC for Arduino core provides a comprehensive set of APIs, examples, and tools for developing a wide range of applications, allowing developers to leverage the ease of use and flexibility of the Arduino platform while harnessing the advanced features and performance of the XMC™ microcontrollers. diff --git a/docs/development-instructions.rst b/docs/development-instructions.rst index cc0d8a4a..7046757c 100644 --- a/docs/development-instructions.rst +++ b/docs/development-instructions.rst @@ -114,7 +114,7 @@ If you are developing a new built-in library, please refer to ``libraries\CAN\Ma Automated Build Checks ^^^^^^^^^^^^^^^^^^^^^^^^ Currently a GitHub Action workflow is used for automatic compilation checking. -Workflows are defined `here `_. +Workflows are defined `here `_. Validation Test ^^^^^^^^^^^^^^^^ diff --git a/libraries/CAN/README.md b/libraries/CAN/README.md index 89968a20..e6bebd8d 100644 --- a/libraries/CAN/README.md +++ b/libraries/CAN/README.md @@ -15,7 +15,7 @@ All CAN nodes should be connected using the (twisted) pair cable for the CAN_H a # Software Usage -There are [examples](libraries/CAN/examples). See the API definition below for more details. +There are [examples](examples). See the API definition below for more details. # CAN API diff --git a/package/package_xmc_index.template.json b/package/package_xmc_index.template.json index 45e045d8..cae00042 100644 --- a/package/package_xmc_index.template.json +++ b/package/package_xmc_index.template.json @@ -55,20 +55,20 @@ { "host": "i686-mingw32", "archiveFileName": "gcc-arm-none-eabi-10.3-2021.10-win32.zip", - "url": "https://developer.arm.com/-/media/Files/downloads/gnu-rm/10.3-2021.10/gcc-arm-none-eabi-10.3-2021.10-win32.zip", + "url": "https://armkeil.blob.core.windows.net/developer/Files/downloads/gnu-rm/10.3-2021.10/gcc-arm-none-eabi-10.3-2021.10-win32.zip", "checksum": "SHA-256:d287439b3090843f3f4e29c7c41f81d958a5323aecefcf705c203bfd8ae3f2e7", "size": "200578763" }, { "host": "x86_64-apple-darwin", - "url": "https://developer.arm.com/-/media/Files/downloads/gnu-rm/10.3-2021.10/gcc-arm-none-eabi-10.3-2021.10-mac.tar.bz2", + "url": "https://armkeil.blob.core.windows.net/developer/Files/downloads/gnu-rm/10.3-2021.10/gcc-arm-none-eabi-10.3-2021.10-mac.tar.bz2", "archiveFileName": "gcc-arm-none-eabi-10.3-2021.10-mac.tar.bz2", "checksum": "SHA-256:fb613dacb25149f140f73fe9ff6c380bb43328e6bf813473986e9127e2bc283b", "size": "158961466" }, { "host": "x86_64-pc-linux-gnu", - "url": "https://developer.arm.com/-/media/Files/downloads/gnu-rm/10.3-2021.10/gcc-arm-none-eabi-10.3-2021.10-x86_64-linux.tar.bz2", + "url": "https://armkeil.blob.core.windows.net/developer/Files/downloads/gnu-rm/10.3-2021.10/gcc-arm-none-eabi-10.3-2021.10-x86_64-linux.tar.bz2", "archiveFileName": "gcc-arm-none-eabi-10.3-2021.10-x86_64-linux.tar.bz2", "checksum": "SHA-256:97dbb4f019ad1650b732faffcc881689cedc14e2b7ee863d390e0a41ef16c9a3", "size": "157089706"