Skip to content

Commit e73564c

Browse files
authored
Merge branch 'main' into highlightLiveWatch
2 parents 8551a8e + 86270d7 commit e73564c

10 files changed

Lines changed: 125 additions & 111 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
## Fixes
2-
<!-- List the GitHub issue this PR resolves -->
3-
4-
- [#<Number>](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/<number>)
2+
<!-- List the GitHub issue(s) this PR resolves (e.g. #123) -->
3+
- #<issue-number>
54

65
## Changes
76
<!-- List the changes this PR introduces -->

.github/lychee.toml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# For all options, see <https://lychee.cli.rs/usage/config/>
2+
3+
# Verbose program output
4+
# Accepts log level: "error", "warn", "info", "debug", "trace"
5+
verbose = "info"
6+
7+
# Interactive progress bar while checking links.
8+
# Disabled for CI usage
9+
no_progress = true
10+
cache = false
11+
12+
accept = [
13+
"200"
14+
]
15+
16+
# Maximum number of allowed redirects.
17+
max_redirects = 2
18+
19+
# Maximum number of allowed retries before a link is declared dead.
20+
max_retries = 2
21+
22+
# Only test links with the given schemes
23+
# Omit to check links with any other scheme.
24+
scheme = ["http", "https", "file"]
25+
26+
# Exclude links
27+
exclude = [
28+
# Needs cookies to be accepted
29+
'https://developer.arm.com',
30+
'https://www.segger.com'
31+
]
32+
33+
# Exclude paths from getting checked. The values are treated as regular expressions
34+
exclude_path = [
35+
"(^|[\\\\/])CHANGELOG\\.md$", # skip changelog file
36+
"\\.txt$", # skip .txt extensions
37+
"\\.html$", # skip .html extensions
38+
]

.github/workflows/dependency-review.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ jobs:
2121
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
2222

2323
- name: 'Dependency Review'
24-
uses: actions/dependency-review-action@2031cfc080254a8a887f58cffee85186f0e49e48 # v4.9.0
24+
uses: actions/dependency-review-action@a1d282b36b6f3519aa1f3fc636f609c47dddb294 # v5.0.0

.github/workflows/markdown.yml

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -45,35 +45,18 @@ jobs:
4545
check-links:
4646
name: Check Markdown Links
4747
runs-on: ubuntu-latest
48-
permissions:
49-
packages: read
5048
steps:
5149
- name: Harden the runner (Audit all outbound calls)
5250
uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4
5351
with:
5452
egress-policy: audit
5553

56-
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
57-
58-
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
59-
env:
60-
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
61-
with:
62-
node-version-file: package.json
63-
registry-url: https://npm.pkg.github.com
64-
package-manager-cache: false
65-
66-
- name: Install dependencies
67-
env:
68-
GITHUB_TOKEN: ${{ github.token }}
69-
run: npm ci
54+
- name: Checkout repository
55+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
7056

71-
# Automatically retry the link check if it fails
72-
# This helps reduce false positives in CI caused by transient errors
7357
- name: Check Links
74-
if: runner.os == 'Linux'
75-
uses: Wandalen/wretry.action@e68c23e6309f2871ca8ae4763e7629b9c258e1ea # v3.8.0
58+
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
7659
with:
77-
attempt_delay: 2000
78-
attempt_limit: 3
79-
command: npm run check:links
60+
args: --config .github/lychee.toml './**/*.md'
61+
fail: true
62+
jobSummary: true

.github/workflows/nightly.yml

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,24 @@ permissions:
1313
contents: read
1414

1515
jobs:
16+
validate-markdown-links:
17+
name: Validate Markdown Links
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Harden the runner (Audit all outbound calls)
21+
uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4
22+
with:
23+
egress-policy: audit
24+
25+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
26+
27+
- name: Validate Links
28+
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
29+
with:
30+
args: --config .github/lychee.toml './**/*.md'
31+
fail: true
32+
jobSummary: false
33+
1634
build:
1735
if: github.repository == 'Open-CMSIS-Pack/vscode-cmsis-debugger'
1836
strategy:
@@ -84,16 +102,6 @@ jobs:
84102
if: runner.os == 'Linux'
85103
run: npm run build
86104

87-
# Automatically retry the link check if it fails
88-
# This helps reduce false positives in CI caused by transient errors
89-
- name: Check Links
90-
if: runner.os == 'Linux'
91-
uses: Wandalen/wretry.action@e68c23e6309f2871ca8ae4763e7629b9c258e1ea # v3.8.0
92-
with:
93-
attempt_delay: 2000
94-
attempt_limit: 3
95-
command: npm run check:links
96-
97105
- name: Check copyright
98106
if: runner.os == 'Linux'
99107
run: npm run copyright:check

.github/workflows/tpip.yml

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77
- docs/third-party-licenses.json
88
- docs/tpip-header.md
99
- scripts/tpip-reporter.ts
10+
- package-lock.json
1011
- '!**/*.md'
1112
- '!.github/workflows/markdown.yml'
1213
- '!.github/markdownlint.json'
@@ -25,8 +26,9 @@ permissions:
2526
jobs:
2627
report:
2728
permissions:
28-
# contents: write # for Git to git push # disabled until resurrecting direct git push
29+
contents: write
2930
packages: read
31+
actions: read
3032

3133
name: Generate report
3234
runs-on: ubuntu-latest
@@ -52,13 +54,20 @@ jobs:
5254
run: npm ci
5355

5456
- name: Generate third-party licenses report
55-
run: npm run tpip:report
57+
id: report
58+
run: |
59+
npm run tpip:report
60+
if git diff --exit-code TPIP.md > /dev/null; then
61+
echo "update=0" >> $GITHUB_OUTPUT
62+
else
63+
echo "update=1" >> $GITHUB_OUTPUT
64+
fi
5665
5766
- name: Commit changes
58-
if: false
59-
run: |
60-
git config --local user.email "git@github.com"
61-
git config --local user.name "GitHub Action"
62-
git add TPIP.md
63-
git commit -m "Update third-party licenses report [skip ci]"
64-
git push
67+
if: ${{ steps.report.outputs.update == 1 }}
68+
uses: EndBug/add-and-commit@290ea2c423ad77ca9c62ae0f5b224379612c0321
69+
with:
70+
message: "Update TPIP report [skip ci]"
71+
add: |
72+
docs/third-party-licenses.json
73+
TPIP.md

TPIP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TPIP Report for vscode-cmsis-debugger
22

3-
Report prepared at: 06/05/2026, 17:17:17
3+
Generated for release: 1.6.1
44

55
| *Package* | *Version* | *Repository* | *License* |
66
|---|---|---|---|

package-lock.json

Lines changed: 32 additions & 61 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -741,7 +741,7 @@
741741
"ts-jest": "29.4.6",
742742
"ts-loader": "^9.5.4",
743743
"ts-node": "^10.9.2",
744-
"tsx": "^4.21.0",
744+
"tsx": "^4.22.4",
745745
"type-fest": "^5.4.4",
746746
"typescript": "^5.9.3",
747747
"typescript-eslint": "8.56.1",

scripts/tpip-reporter.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,13 @@ async function main() {
4444
.parseSync();
4545

4646
const tpipJson = JSON.parse(fs.readFileSync(json as string, "utf8"));
47-
47+
48+
let release: string | undefined;
49+
if (fs.existsSync('package.json')) {
50+
const packageJson = JSON.parse(fs.readFileSync('package.json', 'utf8'));
51+
release = packageJson.version;
52+
}
53+
4854
var data: string = '';
4955
if (header && fs.existsSync(header as string)) {
5056
data += fs.readFileSync(header as string, "utf8");
@@ -53,7 +59,7 @@ async function main() {
5359
}
5460

5561
data += '\n';
56-
data += `Report prepared at: ${new Date().toLocaleString('en-GB')}\n\n`;
62+
data += `Generated for release: ${release ?? 'unknown'}\n\n`;
5763
data += '| *Package* | *Version* | *Repository* | *License* |\n';
5864
data += '|---|---|---|---|\n';
5965

0 commit comments

Comments
 (0)