Skip to content

Add docs to the CI workflow#38

Merged
transientlunatic merged 1 commit intov0.7-previewfrom
add-docs-workflow
Jan 22, 2026
Merged

Add docs to the CI workflow#38
transientlunatic merged 1 commit intov0.7-previewfrom
add-docs-workflow

Conversation

@transientlunatic
Copy link
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings December 23, 2025 16:53
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds documentation building to the GitHub Actions CI workflow and introduces several other improvements including HTCondor integration tests, htcondor2 compatibility updates, and various bug fixes.

Key Changes

  • Adds automated documentation building and deployment via GitHub Actions using sphinx-multiversion
  • Introduces comprehensive HTCondor integration testing in both GitHub Actions and GitLab CI
  • Updates Python imports to support htcondor2 with fallback to htcondor for better compatibility
  • Improves Python executable detection with better error handling
  • Fixes indentation bug in review CLI module

Reviewed changes

Copilot reviewed 15 out of 16 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
.github/workflows/docs.yml New workflow for building and deploying documentation with sphinx-multiversion to GitHub Pages
.github/workflows/htcondor-tests.yml New comprehensive HTCondor integration test workflow using htcondor/mini container
.github/workflows/python-app.yml Updated to use pip install . and simplified test commands
.gitlab-ci.yml Adds HTCondor integration test stage with conda environment setup
asimov/condor.py Adds try/except block to import htcondor2 as htcondor with fallback to htcondor
asimov/pipeline.py Adds try/except block to import htcondor2 as htcondor with fallback to htcondor
asimov/pipelines/pesummary.py Adds try/except block to import htcondor2 as htcondor with fallback to htcondor
asimov/analysis.py Changes imports from absolute to relative imports
asimov/cli/project.py Improves Python executable detection with walrus operator and better error handling
asimov/cli/review.py Fixes indentation to move else block to correct level
pyproject.toml Adds missing package entries for asimov.pipelines, asimov.cli, and asimov.configs
conda/environment.yaml New conda environment specification with required dependencies
tests/tmp/project/.asimov/asimov.conf Test fixture configuration file for HTCondor tests
tests/test_blueprints/*.yaml Test blueprint configurations for GWOSC integration tests

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

python_loc = python_loc.split("/")[:-2]
else:
raise RuntimeError("Unable to find python executable in PATH")

Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line has trailing whitespace which should be removed for code cleanliness.

Suggested change

Copilot uses AI. Check for mistakes.
import htcondor # NoQA
try:
warnings.filterwarnings("ignore", module="htcondor2")
import htcondor2 as htcondor # NoQA
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's inconsistent spacing around the comment. This line has a space before the comment while the identical line in asimov/pipeline.py (line 13) and asimov/condor.py (line 17) have two spaces. Consider maintaining consistency across files.

Suggested change
import htcondor2 as htcondor # NoQA
import htcondor2 as htcondor # NoQA

Copilot uses AI. Check for mistakes.
Comment on lines +129 to +130
# Change to the submit user
- su - submituser
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The su - submituser command starts an interactive login shell, but in a CI script context, the subsequent commands will continue to execute as the original user (root), not as submituser. This differs from the GitHub workflow which uses shell: sudo -E -u submituser bash -el {0} to properly execute commands as submituser. Consider removing this line or restructuring the script to properly execute as submituser if that's the intent.

Suggested change
# Change to the submit user
- su - submituser
# Change to the submit user (removed ineffective su invocation; commands run as the CI user)

Copilot uses AI. Check for mistakes.
@@ -0,0 +1,77 @@
name: Build and Deploy Documentation
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR title "Add docs to the CI workflow" doesn't fully capture the scope of changes in this PR, which also includes adding HTCondor integration tests, updating htcondor imports to support htcondor2, fixing Python executable detection, and other improvements. Consider updating the PR description or title to reflect all significant changes.

Copilot uses AI. Check for mistakes.
@transientlunatic transientlunatic changed the base branch from master to v0.7-preview January 22, 2026 15:57
@transientlunatic transientlunatic merged commit 7db9d38 into v0.7-preview Jan 22, 2026
7 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants