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

Fix CLI docs action #730

Merged
merged 43 commits into from
Dec 20, 2024
Merged

Fix CLI docs action #730

merged 43 commits into from
Dec 20, 2024

Conversation

i-oden
Copy link
Member

@i-oden i-oden commented Dec 17, 2024

Read this before submitting the PR

  1. Always create a Draft PR first
  2. Go through sections 1-5 below, fill them in and check all the boxes
  3. Make sure that the branch is updated; if there's an "Update branch" button at the bottom of the PR, rebase or update branch.
  4. When all boxes are checked, information is filled in, and the branch is updated: mark as Ready For Review and tag reviewers (top right)
  5. Once there is a submitted review, implement the suggestions (if reasonable, otherwise discuss) and request an new review.

If there is a field which you are unsure about, enter the edit mode of this description or go to the PR template; There are invisible comments providing descriptions which may be of help.

1. Description / Summary

This PR fixes the issue with the action publishing the CLI docs to GitHub Pages.
The issue is due to Python 3.13 having removed some packages, which is why I have included the legacy versions of them in the requirements-dev.txt.
@rv0lt Also fixed the deployment of the docs by bumping some of the sphinx packages but that also meant that the majority of the docs were not visible and there were no links to the different commands.

This is in no way the best option, but this fixes it. We should however, as discussed, change this entire process to use some action that is well maintained, or create our own action which we would have full permissions on and could fix when issues arise.

2. Jira task / GitHub issue

Link to the github issue or add the Jira task ID here.

3. Type of change

What type of change(s) does the PR contain?

Check the relevant boxes below. For an explanation of the different sections, enter edit mode of this PR description template.

  • New feature
    • Breaking: Why / How? Add info here.
    • Non-breaking
  • Bug fix
  • Security Alert fix
    • Package update
      • Major version update
  • Documentation
  • Workflow
  • Tests only

4. Additional information

5. Actions / Scans

Check the boxes when the specified checks have passed.

For information on what the different checks do and how to fix it if they're failing, enter edit mode of this description or go to the PR template.

  • Black
  • Pylint
  • Prettier
  • Yamllint
  • Tests
  • TestPyPI
  • CodeQL
  • Trivy
  • Snyk

@rv0lt
Copy link
Member

rv0lt commented Dec 17, 2024

My mind is already giving up, but I have been testing in branch ghp-test and I found out the issue is within the action

matthiaszepper/sphinx-action-v4

It uses by default python 3.13 which has compatibility issues with this cffi module. I have been trying workarounds but to no avail sadly.

The other issue with python 3.13 is that this module was removed
https://docs.python.org/3.11/library/imghdr.html

Which is need for sphinx to make the documents.

And, don't expect Sphinx to add support for python 3.13 until 2026 xd
https://www.sphinx-doc.org/en/master/internals/release-process.html


EDIT: After inspecting more deeply (yapping incoming)

This action is a forked for another one, that this creator suggested was abandonded (whereas the original one allows specifying a version and does not default to latests) and it's now, surprise, abandoned
https://github.com/MatthiasZepper/sphinx-action-v4

I believe it will be MUCH better to just have extra steps and generate the document ourselves instead of relying on libraries maintained by random people...

@i-oden i-oden self-assigned this Dec 18, 2024
Copy link

codecov bot commented Dec 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.88%. Comparing base (7972db5) to head (a5aba24).
Report is 117 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #730      +/-   ##
==========================================
+ Coverage   47.76%   47.88%   +0.12%     
==========================================
  Files          31       31              
  Lines        2889     2890       +1     
==========================================
+ Hits         1380     1384       +4     
+ Misses       1509     1506       -3     

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

@i-oden i-oden marked this pull request as ready for review December 19, 2024 11:19
@i-oden i-oden requested a review from a team as a code owner December 19, 2024 11:19
@i-oden
Copy link
Member Author

i-oden commented Dec 20, 2024

@ScilifelabDataCentre/teamhermes When there's an approval of this you can merge.

@reutenauer reutenauer merged commit e24d95b into dev Dec 20, 2024
16 checks passed
@valyo valyo deleted the cli-docs branch December 20, 2024 13:07
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.

3 participants