Skip to content

Update GitHub Actions and ReadTheDocs workflows to use modern conda setup#78

Open
Copilot wants to merge 4 commits intomainfrom
copilot/fix-77
Open

Update GitHub Actions and ReadTheDocs workflows to use modern conda setup#78
Copilot wants to merge 4 commits intomainfrom
copilot/fix-77

Conversation

Copy link

Copilot AI commented Jul 3, 2025

The documentation workflow was failing due to deprecated Mambaforge usage. This PR updates all GitHub Actions workflows and ReadTheDocs configuration to use modern, supported tooling.

Changes Made

🔧 Fixed Deprecated Mambaforge Usage

  • Updated docs.yaml workflow to use miniforge-variant: Miniforge3 instead of deprecated Mambaforge
  • Updated gh-ci.yaml workflow to use miniforge-variant: Miniforge3 instead of deprecated Mambaforge
  • Updated readthedocs.yaml to use python: "3.11" instead of deprecated python: "mambaforge-22.9"

📦 Updated GitHub Actions Versions

  • Updated actions/checkout@v3actions/checkout@v4 (consistency fix)
  • Updated actions/setup-python@v4actions/setup-python@v5 (latest stable)
  • Updated peaceiris/actions-gh-pages@v3peaceiris/actions-gh-pages@v4 (latest stable)

🧹 Repository Cleanup

  • Added docs/html/ to .gitignore to exclude documentation build artifacts

Testing

  • ✅ Successfully built documentation locally using the updated conda environment
  • ✅ Validated all YAML files for syntax correctness
  • ✅ Verified the conda environment setup works with the new Miniforge3 configuration

Before/After

Before: Workflows failing with deprecation warnings:

Warning: Future Miniforge releases will NOT build Mambaforge installers. 
We advise you switch to Miniforge at your earliest convenience.

After: Workflows use modern, supported conda tooling that will continue to work long-term.

These changes ensure the documentation builds will continue to work reliably without deprecation warnings.

Fixes #77.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • docs.mdanalysis.org
    • Triggering command: /usr/share/miniconda/envs/propkatrajdocs/bin/python3.13 /usr/share/miniconda/envs/propkatrajdocs/bin/sphinx-build -T -E --keep-going -b html -D language=en sphinx html (dns block)
  • docs.python.org
    • Triggering command: /usr/share/miniconda/envs/propkatrajdocs/bin/python3.13 /usr/share/miniconda/envs/propkatrajdocs/bin/sphinx-build -T -E --keep-going -b html -D language=en sphinx html (dns block)
  • numpy.org
    • Triggering command: /usr/share/miniconda/envs/propkatrajdocs/bin/python3.13 /usr/share/miniconda/envs/propkatrajdocs/bin/sphinx-build -T -E --keep-going -b html -D language=en sphinx html (dns block)
  • pandas.pydata.org
    • Triggering command: /usr/share/miniconda/envs/propkatrajdocs/bin/python3.13 /usr/share/miniconda/envs/propkatrajdocs/bin/sphinx-build -T -E --keep-going -b html -D language=en sphinx html (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 2 commits July 3, 2025 23:40
…etup

Co-authored-by: orbeckst <237980+orbeckst@users.noreply.github.com>
Co-authored-by: orbeckst <237980+orbeckst@users.noreply.github.com>
Copilot AI changed the title [WIP] update docs GHA workflow Update GitHub Actions and ReadTheDocs workflows to use modern conda setup Jul 3, 2025
Copilot AI requested a review from orbeckst July 3, 2025 23:45
Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

  • ignore docs/html
  • ensure that all status checks pass, including Read The Docs

@codecov
Copy link

codecov bot commented Jul 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.30%. Comparing base (bbd5735) to head (3bc04f8).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #78   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files           2        2           
  Lines          59       59           
=======================================
  Hits           58       58           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@orbeckst orbeckst marked this pull request as ready for review July 4, 2025 02:08
@orbeckst
Copy link
Member

@copilot status checks are still failing for some windows versions. How can this be fixed?

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.

update docs GHA workflow

2 participants