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

Documentation release workflow #3321

Merged

Conversation

ericpre
Copy link
Member

@ericpre ericpre commented Feb 26, 2024

Add documentation on how the documentation is updated and the required manual changes for minor and major release.

Progress of the PR

  • Update doc workflow to push documentation on tag,
  • Fix wrong section name in plot_roi_map docstring,
  • [n/a] update docstring (if appropriate),
  • update dev guide (if appropriate),
  • add an changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
  • Check formatting changelog entry in the readthedocs doc build of this PR (link in github checks)
  • [n/a] add tests,
  • ready for review.

Copy link

codecov bot commented Feb 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.51%. Comparing base (1d225cc) to head (714bd2a).

Additional details and impacted files
@@                 Coverage Diff                 @@
##           RELEASE_next_patch    #3321   +/-   ##
===================================================
  Coverage               80.51%   80.51%           
===================================================
  Files                     147      147           
  Lines                   21869    21869           
  Branches                 5146     5146           
===================================================
  Hits                    17607    17607           
  Misses                   3044     3044           
  Partials                 1218     1218           

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

@ericpre ericpre added this to the v2.0.1 milestone Feb 26, 2024
@ericpre ericpre requested a review from jlaehne February 26, 2024 11:43
.github/workflows/doc.yml Show resolved Hide resolved
doc/dev_guide/writing_docs.rst Outdated Show resolved Hide resolved
doc/dev_guide/writing_docs.rst Outdated Show resolved Hide resolved
doc/dev_guide/writing_docs.rst Outdated Show resolved Hide resolved
releasing_guide.md Outdated Show resolved Hide resolved
upcoming_changes/3321.maintenance.rst Outdated Show resolved Hide resolved
@ericpre ericpre merged commit 6f6a54a into hyperspy:RELEASE_next_patch Feb 26, 2024
26 checks passed
@ericpre ericpre deleted the documentation_release_workflow branch March 2, 2024 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants