Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI: set QED dependencies for doc build to dev branch version, if target branch is not main #115

Merged
merged 1 commit into from
Aug 21, 2024
Merged

CI: set QED dependencies for doc build to dev branch version, if target branch is not main #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/BuildDeployDoc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ jobs:
julia --project=docs/ -e 'import Pkg; Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/JuliaRegistries/General"));'
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: set dependencies to dev branch version
if: (github.event_name == 'push' && github.ref_name != 'main') || (github.event_name == 'pull_request' && github.base_ref != 'main')
run: |
git clone -b dev https://github.com/QEDjl-project/QED.jl.git /tmp/integration_test_tools
julia --project=docs/ /tmp/integration_test_tools/.ci/set_dev_dependencies.jl
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
Expand Down
8 changes: 3 additions & 5 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,6 @@ Pkg.develop(; path=project_path)
using Documenter
using QEDbase

#DocMeta.setdocmeta!(QEDbase, :DocTestSetup, :(using QEDbase); recursive=true)

# TODO: remove before release
Pkg.add(; url="https://github.com/QEDjl-project/QEDcore.jl", rev="dev")

using DocumenterCitations

bib = CitationBibliography(joinpath(@__DIR__, "Bibliography.bib"))
Expand Down Expand Up @@ -41,6 +36,9 @@ makedocs(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://qedjl-project.gitlab.io/QEDbase.jl",
assets=String[],
# TODO: workaround
# should be fixed: https://github.com/QEDjl-project/QEDbase.jl/issues/4
size_threshold_ignore=["index.md"],
),
pages=pages,
plugins=[bib],
Expand Down
Loading