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

[DOC] update maintenance documentation for the releases #4250

Closed
wants to merge 2 commits into from

Conversation

Remi-Gau
Copy link
Collaborator

Changes proposed in this pull request:

Updates to release process and its doc

  • add a git push to push the doc to be deployed
  • move section about github release
  • mention zenodo DOI that was not explicitly mentioned anywhere

Copy link
Contributor

👋 @Remi-Gau 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.

Copy link

codecov bot commented Jan 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (29ae5f1) 92.06% compared to head (d60a15a) 92.06%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4250   +/-   ##
=======================================
  Coverage   92.06%   92.06%           
=======================================
  Files         144      144           
  Lines       16419    16419           
  Branches     3434     3434           
=======================================
  Hits        15116    15116           
  Misses        761      761           
  Partials      542      542           
Flag Coverage Δ
macos-latest_3.11_test_plotting 91.85% <ø> (?)
macos-latest_3.12_test_plotting 91.85% <ø> (?)
macos-latest_3.8_test_plotting 91.81% <ø> (?)
macos-latest_3.9_test_plotting 91.82% <ø> (?)
ubuntu-latest_3.10_test_plotting 91.85% <ø> (ø)
ubuntu-latest_3.11_test_plotting 91.85% <ø> (ø)
ubuntu-latest_3.12_test_plotting 91.85% <ø> (?)
ubuntu-latest_3.8_test_min 68.94% <ø> (ø)
ubuntu-latest_3.8_test_plot_min 91.56% <ø> (ø)
ubuntu-latest_3.8_test_plotting 91.81% <ø> (ø)
ubuntu-latest_3.9_test_plotting 91.82% <ø> (ø)
windows-latest_3.11_test_plotting ?
windows-latest_3.8_test_plotting ?
windows-latest_3.9_test_plotting 91.79% <ø> (?)

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 Remi-Gau changed the title update doc for release [DOC] update maintenance documentation for the releases Jan 30, 2024
Copy link
Member

@bthirion bthirion left a comment

Choose a reason for hiding this comment

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

LGTM.
Bzw, I realize we don't have an example showcasing #4067
It would be good to show it otherwise we may surprise users.

@Remi-Gau
Copy link
Collaborator Author

I realize we don't have an example showcasing #4067 It would be good to show it otherwise we may surprise users.

So it was included when we merged the similar GLM exmaples in #3191 :

Resulting examples has "short" contrasts and there is warning that will always say when the contrasts was padded.

https://nilearn.github.io/stable/auto_examples/04_glm_first_level/plot_two_runs_model.html#compare-run-specific-and-fixed-effects-contrasts

It felt right to do in this case, because the older examples did specifically include a padding function:

def pad_vector(contrast_, n_columns):

But you are correct that the padding is now happening "implicitly" (except for the warning) and it should probably be mentioned in the text of the example.

@Remi-Gau
Copy link
Collaborator Author

check #4245 (comment) before merging

@Remi-Gau Remi-Gau marked this pull request as draft January 31, 2024 13:52
@bthirion
Copy link
Member

OK, i had not realized that. Well, the warning plays its role. Note sure we need to do much more than that.

@Remi-Gau
Copy link
Collaborator Author

superseded by #4371

@Remi-Gau Remi-Gau closed this Apr 10, 2024
@Remi-Gau Remi-Gau deleted the release_doc branch April 10, 2024 07:32
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 maintenance doc related to doc pushing
2 participants