Skip to content

fix: properly configure GitHub Actions build command #117

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

Merged
rich-iannone merged 1 commit into from
Apr 18, 2026
Merged

fix: properly configure GitHub Actions build command #117

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
2 changes: 1 addition & 1 deletion great_docs/assets/github-workflow-template.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
uses: quarto-dev/quarto-actions/setup@v2

- name: Build docs
run: great-docs build
run: {build_command}

- name: Save docs artifact
uses: actions/upload-artifact@v7
Expand Down
4 changes: 4 additions & 0 deletions great_docs/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -681,11 +681,13 @@ def setup_github_pages(
python -m pip install uv
uv sync
uv pip install {great_docs_install}"""
build_command = "uv run great-docs build"
elif package_manager == "poetry":
install_commands = f"""\
python -m pip install poetry
poetry install
poetry run pip install {great_docs_install}"""
build_command = "poetry run great-docs build"
else:
# pip: try to detect optional dependencies
optional_deps = _detect_optional_dependencies(project_root)
Expand All @@ -701,6 +703,7 @@ def setup_github_pages(
python -m pip install --upgrade pip
python -m pip install -e .
python -m pip install {great_docs_install}"""
build_command = "great-docs build"

# Create .github/workflows directory
workflow_dir = project_root / ".github" / "workflows"
Expand Down Expand Up @@ -739,6 +742,7 @@ def setup_github_pages(
workflow_content = workflow_content.replace("{ python_version }", python_version)
workflow_content = workflow_content.replace("{python_version}", python_version)
workflow_content = workflow_content.replace("{install_commands}", install_commands)
workflow_content = workflow_content.replace("{build_command}", build_command)

# Write workflow file
workflow_file.write_text(workflow_content)
Expand Down
Loading