Skip to content

Commit cf51f5b

Browse files
authored
CI: add URL checks searching for broken HTTP links in source code, docs, etc (#434)
1 parent 0e3db80 commit cf51f5b

File tree

3 files changed

+28
-18
lines changed

3 files changed

+28
-18
lines changed

.github/workflows/urlcheck.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: urlcheck
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
schedule:
9+
- cron: '0 13 * * 4'
10+
11+
jobs:
12+
url-check:
13+
runs-on: ubuntu-24.04
14+
steps:
15+
- uses: actions/[email protected]
16+
- uses: urlstechie/urlchecker-action@master
17+
with:
18+
file_types: .md,.py,.json,.ipynb,.yaml,.yml,.toml,.c,.hpp,.cpp,.F90,.f90,.txt,.dat,.cff
19+
print_all: false
20+
verbose: true
21+
timeout: 7
22+
retry_count: 3
23+
exclude_urls: https://www.gnu.org/licenses/gpl-3.0.en.html,https://www.gnu.org/licenses/gpl-3.0.html,https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
24+
exclude_patterns: http://purl.org,http://www.w3.org
25+
exclude_files: .github/workflows/urlcheck.yml

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ pip install PyPartMC[examples]
9999

100100
## Features
101101

102-
- works on Linux, macOS and Windows (compatibility assured with [CI builds](https://github.com/open-atmos/PyPartMC/blob/main/.github/workflows/tests.yml))
102+
- works on Linux, macOS and Windows (compatibility assured with [CI builds](https://github.com/open-atmos/PyPartMC/blob/main/.github/workflows/buildwheels.yml))
103103
- hassle-free installation using `pip` (prior PartMC installation **not needed**)
104104
- works out of the box on [mybinder.org](https://mybinder.org/), [Google Colab](colab.research.google.com/) and alike
105105
- ships with [a set of examples](https://github.com/open-atmos/PyPartMC/tree/main/examples) maintained in a form of Jupyter notebooks

examples/additive_coag_comparison.ipynb

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -512,8 +512,8 @@
512512
"class RunDropletsJL(Run):\n",
513513
" def __init__(self, _):\n",
514514
" BASE_URL = (\n",
515-
" 'https://raw.githubusercontent.com/emmacware/droplets.jl/REVISION/'\n",
516-
" ).replace('REVISION', 'c3b5ae4edf12c7b10dc8759639f18de1267bc52b')\n",
515+
" 'https://raw.githubusercontent.com/emmacware/droplets.jl/refs/heads/main/README.md'\n",
516+
" ).replace('refs/heads/main/README.md', 'c3b5ae4edf12c7b10dc8759639f18de1267bc52b/')\n",
517517
" for path in (\n",
518518
" 'src/SDfunc/constants.jl', 'src/SDfunc/binning.jl', 'src/SDfunc/coalescence.jl',\n",
519519
" ):\n",
@@ -732,9 +732,6 @@
732732
"execution_count": 12,
733733
"id": "b33d3ccb",
734734
"metadata": {
735-
"colab": {
736-
"base_uri": "https://localhost:8080/"
737-
},
738735
"id": "b33d3ccb",
739736
"outputId": "3ee99629-6f11-415e-8a65-aa5925f05610"
740737
},
@@ -888,18 +885,6 @@
888885
"execution_count": 13,
889886
"id": "6cc84269",
890887
"metadata": {
891-
"colab": {
892-
"base_uri": "https://localhost:8080/",
893-
"height": 1000,
894-
"referenced_widgets": [
895-
"a70a8f1547324003bf5060e4a84ad1b7",
896-
"2790c4f59c444e559a9eafc6d0efcf78",
897-
"8bfad5ba5afa473ebf40426240c7d291",
898-
"e491d2d597bf42218d52dd3e2d86fb64",
899-
"66ea2bf94eb64790b2b53a0a7d28d1d0",
900-
"dd3e2f8ce6f04a808e16ec6da1176ffc"
901-
]
902-
},
903888
"id": "6cc84269",
904889
"outputId": "dc996ce6-b3ed-4278-9968-432c41ac8947"
905890
},

0 commit comments

Comments
 (0)