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

Add separate step to GHA workflow for rust doc #116

Merged
merged 5 commits into from
Apr 8, 2022
Merged

Conversation

DieracDelta
Copy link
Contributor

This PR closes #115 and:

  • Bumps the rust version in flake.lock
  • Adds a separate step for cargo doc so we can view warnings
  • Increases the aggressiveness of the cargo doc invocation. Now it generates private documentation for all workspace members and all examples
  • Fixes some of the encountered warnings

Note that if this check fails locally, it may be a rust stable. Rust stable needs to be at least 1.60.0 which came out very recently (<1 hour at the time of posting). Fenix hasn't run the workflow to generate a new stable toolchain yet.

@DieracDelta DieracDelta changed the title Add GHA workflow for rust doc Add separate step to GHA workflow for rust doc Apr 7, 2022
Copy link
Contributor

@VictorKoenders VictorKoenders left a comment

Choose a reason for hiding this comment

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

I think it'd make sense for the documentation steps to be moved to .github/workflows/doc.yml or something

.github/workflows/build.yml Outdated Show resolved Hide resolved
VictorKoenders
VictorKoenders previously approved these changes Apr 7, 2022
@DieracDelta
Copy link
Contributor Author

I'm going to leave this open until we get access to rust 1.60.0 since this is needed for the workflow to pass

@VictorKoenders
Copy link
Contributor

I think that we should switch this CI to a github runner for now:

From build_libp2p_networking.yml

      - name: Checkout Repository
        uses: actions/checkout@v3

      - name: Configure Git
        run: |
          git config --global url."https://ancient123:${{ secrets.ORG_GITHUB_PATH }}@github.com/".insteadOf git://github.com/
          git config --global url."https://ancient123:${{ secrets.ORG_GITHUB_PAT }}@github.com/".insteadOf ssh://git@github.com/
      - name: Install stable toolchain
        uses: actions-rs/toolchain@v1
        with:
          profile: default
          toolchain: stable
          override: true
          default: true
          components: rustfmt, clippy

      - name: Enable Rust Caching
        uses: Swatinem/rust-cache@v1

Should get rust 1.60

@DieracDelta DieracDelta merged commit 98638f6 into main Apr 8, 2022
@DieracDelta DieracDelta deleted the jr/docs_gha branch April 15, 2022 15:45
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.

Add separate step to GHA workflow for rust doc
2 participants