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 cargo doc on mac and add a test for it #575

Merged
merged 2 commits into from
May 28, 2024

Conversation

tomaszklak
Copy link
Contributor

@tomaszklak tomaszklak commented May 28, 2024

Problem

Cargo doc was not working previously on a macos host.

Solution

Don't use linux only code on macos. Also automated job is added to not break it in future by accident.

☑️ Definition of Done checklist

  • Commit history is clean (requirements)
  • README.md is updated
  • Functionality is covered by unit or integration tests

This should now work on a macos host:
$ cargo +nightly-2024-01-25 doc --features tokio/test-util --workspace --no-deps --document-private-items --lib --all-features --target-dir=public --exclude telio-lana --open
@tomaszklak tomaszklak requested review from Jauler, jjanowsk, packgron and a team as code owners May 28, 2024 08:42
@tomaszklak tomaszklak force-pushed the LLT-5075-fix-cargo-doc-on-mac branch from 16c10bc to e9300fb Compare May 28, 2024 08:44
@mathiaspeters
Copy link
Contributor

Looks good to me, but just as a sanity check, run the action https://github.com/NordSecurity/libtelio/actions/workflows/gh-pages.yml to publish the pages. If it all works I'll happily approve the PR

Copy link
Contributor

@mathiaspeters mathiaspeters left a comment

Choose a reason for hiding this comment

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

+2

My approval won't be enough though since you made changes to workflow files

Copy link
Contributor

@Jauler Jauler left a comment

Choose a reason for hiding this comment

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

+22.0

@tomaszklak tomaszklak merged commit 0a53a94 into main May 28, 2024
65 checks passed
@tomaszklak tomaszklak deleted the LLT-5075-fix-cargo-doc-on-mac branch May 28, 2024 10:16
packgron pushed a commit that referenced this pull request Jun 4, 2024
jjanowsk pushed a commit that referenced this pull request Jun 4, 2024
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