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.

Sign up for GitHub

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

Jump to bottom

CI: fix documentation #435

Merged
merged 7 commits into from
Dec 5, 2023
Merged

CI: fix documentation #435

merged 7 commits into from
Dec 5, 2023

Conversation

pnmadelaine
Copy link
Contributor

@pnmadelaine pnmadelaine commented Dec 1, 2023 •
edited
Loading

This PR tries to fix the GitHub action deploying the documentation.
It currently fails on main, but I am unable to reproduce the error locally.
This PR also enables building the documentation (but not deploying it) on pull requests, to avoid bad surprises when merging in the future.

@pnmadelaine pnmadelaine requested a review from a team as a code owner December 1, 2023 13:29
@cla-bot cla-bot bot added the cla-signed label Dec 1, 2023
@pnmadelaine pnmadelaine marked this pull request as draft December 1, 2023 13:29
@coveralls
Copy link

coveralls commented Dec 1, 2023 •
edited
Loading

Pull Request Test Coverage Report for Build 7092986748

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 54.055%
Totals Coverage Status
Change from base Build 7060381243: 0.0%
Covered Lines: 27829
Relevant Lines: 51483
💛 - Coveralls

@pnmadelaine
Copy link
Contributor Author

It seems that the problem comes from bindgen being broken when using clang 14 and newer. I initially failed to reproduce the error locally because I was still running clang 11.
It seems that the rust workflow was already disabled on ubuntu because of this:

hacl-packages/.github/workflows/rust.yml

Line 43 in eb9f9c6

# - ubuntu-latest Disabling Ubuntu for now as long as bindgen is broken

Since it works on macOS, I suggest we use this for now.

@pnmadelaine pnmadelaine marked this pull request as ready for review December 4, 2023 10:41
franziskuskiefer
franziskuskiefer requested changes Dec 4, 2023
View reviewed changes
Copy link
Member

@franziskuskiefer franziskuskiefer left a comment

Choose a reason for hiding this comment

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

Ah, I didn't think this also runs into that issue. But if this works for now, let's do it. There's just some commented code that should be removed, then let's get this in.

.github/workflows/gh-pages.yml Outdated Show resolved Hide resolved
@franziskuskiefer franziskuskiefer merged commit ba68e0e into main Dec 5, 2023
40 checks passed
@franziskuskiefer franziskuskiefer deleted the pnmadelaine-fix-doc branch December 5, 2023 05:43
protz pushed a commit that referenced this pull request Apr 18, 2024
@pnmadelaine @protz
CI: fix documentation (#435)
33f9750 
* ci: build static content on pull requests
* ci: update `setup-rust-action` when building static content
* ci: build documentation on macos
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@franziskuskiefer franziskuskiefer franziskuskiefer approved these changes

Assignees
No one assigned
Labels
cla-signed
Projects
HACL Packages
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pnmadelaine @coveralls @franziskuskiefer