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.

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

[INFRA] Configure doc build CI to always host artifacts #3990

Merged
merged 2 commits into from Sep 20, 2023

Conversation

ymzayek
Copy link
Member

@ymzayek ymzayek commented Sep 19, 2023

  • Closes None

With the current set up, a failure on the doc build prevents circleci from hosting the docs that have been built. This is annoying since the htmls exist but cannot be easily viewed (sometimes for very trivial errors) and thus hinders the review process. This PR changes the configuration so that the docs are always hosted if a build exists. Note that deploy will still only run on main only with a successful doc build.

I've tested this on my fork on main and in a PR

@github-actions
Copy link
Contributor

👋 @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
Copy link

codecov bot commented Sep 19, 2023

Codecov Report

Merging #3990 (f327a7a) into main (7839e2f) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff            @@
##             main    #3990    +/-   ##
========================================
  Coverage   91.76%   91.76%            
========================================
  Files         134      134            
  Lines       15781    15781            
  Branches     3289     3114   -175     
========================================
  Hits        14482    14482            
  Misses        755      755            
  Partials      544      544            
Flag Coverage Δ
macos-latest_3.10 ?
macos-latest_3.11 ?
macos-latest_3.8 ?
macos-latest_3.9 ?
ubuntu-latest_3.10 91.68% <ø> (ø)
ubuntu-latest_3.11 ?
ubuntu-latest_3.8 91.64% <ø> (ø)
ubuntu-latest_3.9 91.65% <ø> (ø)
windows-latest_3.10 ?
windows-latest_3.11 ?
windows-latest_3.8 ?
windows-latest_3.9 ?

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

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Collaborator

@Remi-Gau Remi-Gau left a comment

Choose a reason for hiding this comment

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

Looks good to me.

At some point we are going to need a diagram how the CI for the doc works. I am still not as good as you are juggling with it.

@bthirion
Copy link
Member

This PR is a bit cryptic to me. Any way to check that it works OK ?

@ymzayek
Copy link
Member Author

ymzayek commented Sep 20, 2023

@bthirion I've run several tests on my fork on main and in a PR

@ymzayek
Copy link
Member Author

ymzayek commented Sep 20, 2023

At some point we are going to need a diagram how the CI for the doc works. I am still not as good as you are juggling with it.

Yes happy to discuss it and explain why we do it this way. We can also think about how to document it better for devs

@Remi-Gau
Copy link
Collaborator

At some point we are going to need a diagram how the CI for the doc works. I am still not as good as you are juggling with it.

Yes happy to discuss it and explain why we do it this way. We can also think about how to document it better for devs.

Can we use mermaid, pretty please?!

flowchart LR
    build-docs.yml --> build_type.sh

😃

@ymzayek
Copy link
Member Author

ymzayek commented Sep 20, 2023

I don't know it but sure happy to try it out!

@Remi-Gau Remi-Gau merged commit 9f692b6 into nilearn:main Sep 20, 2023
29 checks passed
@ymzayek ymzayek deleted the doc-build-hosting branch December 15, 2023 11:38
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.

None yet

3 participants