Skip to content

Commit 06309e0

Browse files
authored
Add markdown link checker (SWE-agent#129)
* Add markdown link checker * Fix & ignore broken markdown links
1 parent 7d71cba commit 06309e0

File tree

3 files changed

+28
-1
lines changed

3 files changed

+28
-1
lines changed

.github/workflows/check-links.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Check Markdown links
2+
3+
on:
4+
push:
5+
pull_request:
6+
schedule:
7+
- cron: "0 0 1 * *"
8+
9+
jobs:
10+
markdown-link-check:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@master
14+
- uses: gaurav-nelson/github-action-markdown-link-check@v1

mlc_config.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "https://github.com/issues?.*"
5+
},
6+
{
7+
"pattern": ".*localhost.*"
8+
},
9+
{
10+
"pattern": "https://platform.openai.com/docs/.*"
11+
}
12+
]
13+
}

scripts/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A single `run.py` call will generate a `trajectory/<username>/<experiment name>`
1111

1212
The following is a comprehensive guide to using the provided `run.py` script, detailing available command-line arguments, their purposes, and default values. Flags that you might find helpful have been marked with a 💡.
1313

14-
The code and explanation of the implementations for *configuration based workflows* are explained in [`agent/`](../agent/README.md).
14+
The code and explanation of the implementations for *configuration based workflows* are explained in [`agent/`](../sweagent/agent/README.md).
1515

1616
Run `python run.py --help` to view this documentation on the command line.
1717

0 commit comments

Comments
 (0)