oamg / convert2rhel

A tool to automate converting Oracle/CentOS/Scientific/Rocky/Alma Linux to Red Hat Enterprise Linux
GNU General Public License v3.0
104 stars 83 forks source link

chore: build docs on PR and push to main #1249

Closed Venefilyn closed 2 months ago

Venefilyn commented 3 months ago

This builds and checks the documentation builds and for commits on main branch it will deploy to GitHub Pages

Confirmed to work on my repo https://venefilyn.github.io/convert2rhel

Jira Issues:

-

Checklist

codecov[bot] commented 2 months ago

Codecov Report

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

Project coverage is 95.73%. Comparing base (fb9b4e0) to head (a0bb712).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1249 +/- ## ======================================= Coverage 95.73% 95.73% ======================================= Files 55 55 Lines 4757 4757 Branches 837 837 ======================================= Hits 4554 4554 Misses 116 116 Partials 87 87 ``` | [Flag](https://app.codecov.io/gh/oamg/convert2rhel/pull/1249/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=oamg) | Coverage Δ | | |---|---|---| | [centos-linux-7](https://app.codecov.io/gh/oamg/convert2rhel/pull/1249/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=oamg) | `90.92% <ø> (ø)` | | | [centos-linux-8](https://app.codecov.io/gh/oamg/convert2rhel/pull/1249/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=oamg) | `91.85% <ø> (ø)` | | | [centos-linux-9](https://app.codecov.io/gh/oamg/convert2rhel/pull/1249/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=oamg) | `91.89% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=oamg#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

has-bot commented 2 months ago

This PR does not require integration tests to be run.


Comment generated by an automation.

Log | Bot Usage
has-bot commented 2 months ago

This PR does not require integration tests to be run.


Comment generated by an automation.

Log | Bot Usage
r0x0d commented 2 months ago

@Venefilyn, the file at .github/workflows/pr-docs-check.yml also needs to be updated with the pip install -r ....

Also, I see that you created a docs/requirements.txt. In the past, I've added the sphinx docs dependencies to each .devcontainer/*/requirements.txt, maybe to keep consistency all around we should remove that dependency from those devcontainers requirements and actually place them in a single place, like the docs/requirements.txt you created? I think that would make it more organized.

Venefilyn commented 2 months ago

Okay @r0x0d should work now. Changed around the syntax a bit for working directory