Skip to content

Commit 903c726

Browse files
committed
update LiterateCheck workflow
1 parent b1ab21e commit 903c726

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

.github/workflows/LiterateCheck.yml

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ on:
88
default: "1"
99
required: false
1010
type: string
11+
localregistry:
12+
description: 'Add local registries hosted on GitHub. Specified by providing the url (https/ssh) to the repositories as a newline (\n) seperated list.
13+
User is responsible for setting up the necessary SSH-Keys to access the repositories if necessary.'
14+
default: ''
1115
outputs:
1216
up_to_date:
1317
description: "If the README.md is up-to-date or not."
@@ -29,13 +33,26 @@ jobs:
2933
- uses: julia-actions/setup-julia@v2
3034
with:
3135
version: "${{ inputs.julia-version }}"
32-
- name: Install Literate and generate docs
33-
shell: julia --color=yes {0}
36+
- name: Setup project
37+
shell: julia --project=docs --color=yes {0}
3438
run: |
35-
using Pkg
36-
Pkg.add(PackageSpec(name="Literate"))
37-
using Literate
38-
Literate.markdown("examples/README.jl", "docs/src"; flavor=Literate.DocumenterFlavor(), name="index")
39+
import Pkg
40+
Pkg.develop(PackageSpec(path=pwd()))
41+
if VERSION >= v"1.8-"
42+
Pkg.Registry.add()
43+
else
44+
Pkg.Registry.add("General")
45+
end
46+
if !isempty("$${{ inputs.localregistry }}")
47+
local_repos = split("${{ inputs.localregistry }}", "\n") .|> string
48+
for repo_url in local_repos
49+
isempty(repo_url) && continue
50+
Pkg.Registry.add(Pkg.RegistrySpec(; url=repo_url))
51+
end
52+
end
53+
retry(Pkg.build)(verbose=true)
54+
- name: "Build README"
55+
run: julia --project=docs/ docs/make_readme.jl
3956
- name: Check if docs need to be updated
4057
id: check-literate
4158
run: |

0 commit comments

Comments
 (0)