search

diffpy / diffpy.fourigui

Other
0 stars 7 forks source link

Build GitHub pages with write permissions - deploy via worfklow dispatch and on publish #68

Closed bobleesj closed 2 weeks ago

bobleesj commented 2 weeks ago

We want to build docs when published (GitHub release) or by workflow dispatch.

github-actions[bot] commented 2 weeks ago

Warning! No news item is found for this PR. If this is a user-facing change/feature/fix, please add a news item by copying the format from news/TEMPLATE.rst.

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 93.78%. Comparing base (402e7d5) to head (b65ad58). Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #68 +/- ## ======================================= Coverage 93.78% 93.78% ======================================= Files 4 4 Lines 177 177 ======================================= Hits 166 166 Misses 11 11 ```
bobleesj commented 2 weeks ago

Ready for review @sbillinge. This will fix the current issue of not displaying the latest changelog. Ref https://github.com/Billingegroup/release-scripts/issues/94

Once you've merged this, could you please run this Deploy Documentation on Release workflow via dispatch? We should then see the latest v0.2.0 news under here https://www.diffpy.org/diffpy.fourigui/release.html

bobleesj commented 2 weeks ago

@cadenmyers13 cc'ing Caden here. Since Andrew's PR has been merged https://github.com/diffpy/diffpy.fourigui/pull/67, let's also check whether the API section builds.

sbillinge commented 2 weeks ago

Deploy docs workflow ran successfully on dispatch

sbillinge commented 2 weeks ago

Changeling appears in the docs now but still no API documentation building?

bobleesj commented 2 weeks ago

Deploy docs workflow ran successfully on dispatch awesome!

@cadenmyers13 could you please check with Andrew why Api doc isn't rendering ?

https://github.com/Billingegroup/release-scripts/blob/v0/.github/workflows/_publish-docs-on-release.yml

This is the script that @sbillinge used to re-render the doc - displaying the latest changelog 0.2.0 now.