[INFRA] Proposal for building stable docs in remote runner for releases

[ymzayek]

• Related to Streamline the release process #2950

TODO:

• Test on fork

[github-actions]

👋 @ymzayek Thanks for creating a PR!

Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft.

Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.

• PR has an interpretable title.
• PR links to Github issue with mention Closes #XXXX (see our documentation on PR structure)
• Code is PEP8-compliant (see our documentation on coding style)
• Changelog or what's new entry in doc/changes/latest.rst (see our documentation on PR structure)

For new features:

• There is at least one unit test per new function / class (see our documentation on testing)
• The new feature is demoed in at least one relevant example.

For bug fixes:

• There is at least one test that would fail under the original bug conditions.

We will review it as quick as possible, feel free to ping us with questions if needed.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7d4d7f3) 91.91% compared to head (954f7b0) 91.93%.
Report is 8 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4160      +/-   ##
==========================================
+ Coverage   91.91%   91.93%   +0.01%     
==========================================
  Files         145      145              
  Lines       16335    16360      +25     
  Branches     3406     3424      +18     
==========================================
+ Hits        15015    15040      +25     
  Misses        777      777              
  Partials      543      543              

Flag	Coverage Δ
macos-latest_3.10_test_plotting	91.71% <ø> (+0.01%)	⬆️
macos-latest_3.11_test_plotting	?
macos-latest_3.12_test_plotting	91.71% <ø> (+0.01%)	⬆️
macos-latest_3.8_test_plotting	?
macos-latest_3.9_test_plotting	91.67% <ø> (+0.01%)	⬆️
ubuntu-latest_3.10_test_plotting	91.71% <ø> (+0.01%)	⬆️
ubuntu-latest_3.11_test_plotting	91.71% <ø> (+0.01%)	⬆️
ubuntu-latest_3.12_test_plotting	91.71% <ø> (+0.01%)	⬆️
ubuntu-latest_3.12_test_pre	91.71% <ø> (+0.01%)	⬆️
ubuntu-latest_3.8_test_min	68.90% <ø> (+0.04%)	⬆️
ubuntu-latest_3.8_test_plot_min	91.43% <ø> (+0.01%)	⬆️
ubuntu-latest_3.8_test_plotting	91.67% <ø> (+0.01%)	⬆️
ubuntu-latest_3.9_test_plotting	91.67% <ø> (+0.01%)	⬆️
windows-latest_3.10_test_plotting	91.68% <ø> (+0.01%)	⬆️
windows-latest_3.11_test_plotting	91.68% <ø> (+0.01%)	⬆️
windows-latest_3.12_test_plotting	91.68% <ø> (+0.01%)	⬆️
windows-latest_3.8_test_plotting	91.64% <ø> (+0.01%)	⬆️
windows-latest_3.9_test_plotting	91.65% <ø> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[Remi-Gau]

Would be great to have this automated!!! 😻

Let me know if you want me to check something in particular.

[ymzayek]

Here is the succesful workflow on my fork

[ymzayek]

whoops here it is: https://github.com/ymzayek/nilearn/actions/runs/7222661348/job/19680065387

So this should be good to go

[Remi-Gau]

wait I am missing something.

should your workflow run show as a new commit on the doc repo: https://github.com/nilearn/nilearn.github.io/commits/main/ ?

[ymzayek]

@Remi-Gau not on main but on this test branch: https://github.com/nilearn/nilearn.github.io/commits/test_build/

In my repo the workflow creates a branch for testing but this is not reflected in this PR

[Remi-Gau]

gotcha!!
super cool.
thanks a bunch for working on this.