Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/check_links.yml
Original file line number Diff line number Diff line change
@@ -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

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {}
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/development-instructions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/Infineon/XMC-for-Arduino/blob/master/.github/workflows/compile-platform-examples.yml>`_.
Workflows are defined `here <https://github.com/Infineon/XMC-for-Arduino/blob/master/.github/workflows/compile-examples.yml>`_.

Validation Test
^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion libraries/CAN/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why change the CAN link here?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it needs to be a relative link, the current paths is added automatically.
The link doesn't work in the current master.


# CAN API

Expand Down
6 changes: 3 additions & 3 deletions package/package_xmc_index.template.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading