Skip to content

Commit 21081a7

Browse files
committed
Run link check on all .md files (#1125)
1 parent 1cc7399 commit 21081a7

File tree

4 files changed

+22
-14
lines changed

4 files changed

+22
-14
lines changed

.github/workflows/markdown.yml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ on:
77
- '.github/markdownlint.jsonc'
88
- '**/*.md'
99
jobs:
10-
markdown-lint:
10+
linter:
1111
name: Lint markdown files
12-
runs-on: ubuntu-22.04
12+
runs-on: ubuntu-latest
1313
steps:
1414
- name: Harden Runner
1515
if: ${{ !github.event.repository.private }}
@@ -36,11 +36,19 @@ jobs:
3636
run: |
3737
echo "::remove-matcher owner=markdownlint::"
3838
39-
- uses: gaurav-nelson/github-action-markdown-link-check@1b916f2cf6c36510a6059943104e3c42ce6c16bc # master
40-
if: always()
39+
check-links:
40+
name: Check markdown links
41+
runs-on: ubuntu-latest
42+
steps:
43+
- name: Checkout devtools
44+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
45+
46+
- name: Check links
47+
uses: gaurav-nelson/github-action-markdown-link-check@1b916f2cf6c36510a6059943104e3c42ce6c16bc # master
48+
# Checks all Markdown files, including those in subfolders,
49+
# as the PR may involve removing referenced Markdown files.
4150
with:
4251
use-quiet-mode: 'yes'
4352
use-verbose-mode: 'yes'
44-
check-modified-files-only: 'yes'
4553
base-branch: ${{ github.base_ref }}
4654
config-file: '.github/markdown-link-check.jsonc'

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ One can directly run the tests from command line.
302302
303303
### Note
304304
305-
- On running the tests, all [required packs](https://github.com/Open-CMSIS-Pack/devtools/blob/main/tools/buildmgr/test/scripts/download_packs.sh#L48-L51) shall get downloaded automatically by [test scripts](https://github.com/Arm-Debug/devtools-external/blob/main/tools/buildmgr/test/scripts/download_packs.sh)\
305+
- On running the tests, all [required packs](https://github.com/Open-CMSIS-Pack/devtools/blob/main/tools/buildmgr/test/scripts/download_packs.sh#L48-L51) shall get downloaded automatically by [test scripts](https://github.com/Open-CMSIS-Pack/devtools/blob/main/tools/buildmgr/test/scripts/download_packs.sh)\
306306
under configured pack repository.
307307
- By default, few special tests are skipped from execution as they are dependent on specific\
308308
environment configuration
@@ -325,7 +325,7 @@ One can directly run the tests from command line.
325325
326326
## Code coverage
327327
328-
Users can generate coverage reports locally using a GNU tool [**lcov**](http://ltp.sourceforge.net/coverage/lcov.php).
328+
Users can generate coverage reports locally using a GNU tool [**lcov**](https://wiki.documentfoundation.org/Development/Lcov).
329329
330330
### Prerequisite
331331

tools/projmgr/OutofScope.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ In a later version of the CMSIS-Toolbox, ASM specific controls may be added.
4646

4747
## Linker Script
4848

49-
In CMSIS-Toolbox 2.0 the [Linker Script Management](Linker-Script-Management.md) will be implemented.
49+
In CMSIS-Toolbox 2.0 the [Linker Script Management](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview/#linker-script-management) will be implemented.
5050

5151
In a later iteration of the tools it should be possible to generate the `regions_<device_or_board>.h` with a workflow that is similar to "CMSIS-Zone" or "DeviceTree".
5252

@@ -61,7 +61,7 @@ The **csolution - CMSIS Project Manager** integrates an extended version of the
6161
- [`phases:`](#phases) defines the execution phases may be used to assign a life-time to memory or peripheral resources
6262
in the project zones.
6363
- [`project-zones:`](#project-zones) collect and configure the memory or peripheral resources that are available to
64-
individual projects. These zones are assigned to the [`projects:`](YML-Input-Format.md#projects) of a `*.csolution.yml` file.
64+
individual projects. These zones are assigned to the [`projects:`](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#projects) of a `*.csolution.yml` file.
6565
- [`requires:`](#requires) allows to specify additional resources at the level of a `*.cproject.yml` or `*.clayer.yml`
6666
file that are added to the related zone of the project.
6767

@@ -199,10 +199,10 @@ requires:
199199

200200
**(Proposal)** Out-of-scope (review if this is really required)
201201

202-
The default RTE directory structure can be modified with [`rte-dirs:`](YML-Input-Format.md#rte-dirs).
202+
The default RTE directory structure can be modified with [`rte-dirs:`](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#rte-dirs).
203203
This list node allows to specify for each software component `Cclass` the directory that should be used to partly share a common configuration across a `project:` or `layer:`.
204204

205-
The `rte-dirs:` list allows to control the location of configuration files for each [component `Cclass`](YML-Input-Format.md#component-name-conventions). A list of `Cclass` names can be assigned to specific directories that store the related configuration files.
205+
The `rte-dirs:` list allows to control the location of configuration files for each [component `Cclass`](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#component-name-conventions). A list of `Cclass` names can be assigned to specific directories that store the related configuration files.
206206

207207
**Example:**
208208

@@ -215,7 +215,7 @@ The `rte-dirs:` list allows to control the location of configuration files for e
215215
for-context: .Debug
216216
```
217217

218-
- With [RTE directory settings](./YML-Input-Format.md#rte-dirs) that are specific to software component `Cclass` names it is possible partly share a common configuration across layers.
218+
- With [RTE directory settings](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#rte-dirs) that are specific to software component `Cclass` names it is possible partly share a common configuration across layers.
219219

220220
## CMSIS-Zone Integration
221221

tools/svdconv/Test/CONTENT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ test input extensions should be placed under this directory.
1919

2020
[integtests](./integtests) directory contains all the sources containing
2121
integration tests and compiles into an executable. The tests make use of test
22-
input SVD files from [test](./test/data/) directory containing the
22+
input SVD files from [test](./data/) directory containing the
2323
example SVD.
2424

2525
## Unit Tests
2626

27-
[unittests](./unittests) holds the sources accommodating all the unit tests and
27+
[unittests](./UnitTests) holds the sources accommodating all the unit tests and
2828
compiles into an executable. These unit tests uses **gtest** as a test framework.

0 commit comments

Comments
 (0)