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

Update uses dependencies for sphinx check #9050

Merged
merged 5 commits into from
Nov 5, 2024

Conversation

kdaily
Copy link
Member

@kdaily kdaily commented Oct 31, 2024

Update actions/checkout to v4 and actions/setup-python to v5 when building the GitHub pages-based contributing guide.

Builds are failing with the following:

> Run make html
  make html
  shell: /usr/bin/bash -e {0}
  env:
    pythonLocation: /opt/hostedtoolcache/Python/3.10.15/x64
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.10.15/x64/lib
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v4.5.0

Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.
make: *** [Makefile:49: html] Error 2
Error: Process completed with exit code 2.

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Update actions/checkout to v4 and
actions/setup-python to v5.
@kdaily kdaily requested review from elysahall and a team October 31, 2024 16:40
@kdaily kdaily marked this pull request as draft October 31, 2024 16:41
@kdaily
Copy link
Member Author

kdaily commented Oct 31, 2024

That's not the right underlying issue, though we should update these. We pin the Sphinx version in the requirements file:

Sphinx==4.5.0

Sphinx==4.5.0

Copy link
Member

@nateprewitt nateprewitt left a comment

Choose a reason for hiding this comment

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

Do we not have dependabot managing these? We should move to hashes ideally and let that all be automated.

@kdaily
Copy link
Member Author

kdaily commented Oct 31, 2024

Agree, looking at enabling that for this branch. Testing locally first to see that Sphinx build is going to work OK with new versions.

To make it easier to install the latest, relax the
versions in requirements.txt and use pip-compile
from pip-tools to make a lockfile.

Update the `make install` command to use the new
lockfile.
@kdaily kdaily marked this pull request as ready for review November 4, 2024 23:28
@kdaily
Copy link
Member Author

kdaily commented Nov 4, 2024

Added dependabot management of GH actions and dependencies on the gh-pages branch here:

#9054

This was previously ignoring a non-existent
directory. Adds the static files directory (which
currently has some long lines that should remain).

Also, specifically enable all linting checks
except for leaked markup, which checks for things
like raw backticks. These are used in bonafide
examples, so they should be ignored.
@kdaily kdaily requested review from nateprewitt and a team November 5, 2024 00:12
@kdaily kdaily merged commit 0519f2c into aws:gh-pages Nov 5, 2024
1 check passed
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.

2 participants