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

docs: fix cargo doc, add to CI check, and pr recipe #297

Merged
merged 5 commits into from
Sep 19, 2024

Conversation

storopoli
Copy link
Member

@storopoli storopoli commented Sep 19, 2024

Description

  • chore: add rustdocs in the pr recipe
  • doc: fix cargo doc lints
  • ci: add docs check in PRs and merge groups
  • chore: don't run cargo doc in dependencies

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature/Enhancement (non-breaking change which adds functionality or enhances an existing one)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactor

Checklist

  • I have performed a self-review of my code.
  • I have commented my code where necessary.
  • I have updated the documentation if needed.
  • My changes do not introduce new warnings.
  • I have added tests that prove my changes are effective or that my feature works.
  • New and existing tests pass with my changes.

Related Issues

Closes STR-337

@storopoli storopoli requested a review from Rajil1213 September 19, 2024 17:52
Copy link
Contributor

@Rajil1213 Rajil1213 left a comment

Choose a reason for hiding this comment

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

Looks good. Maybe remove the compress and archive steps from the workflow file while you're at it.

Otherwise, you can merge this once the CI checks are done (might fail due to the functional tests).

.github/workflows/docs.yml Show resolved Hide resolved
Copy link

codecov bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.53%. Comparing base (7aab4b7) to head (7289e46).
Report is 6 commits behind head on master.

@@            Coverage Diff             @@
##           master     #297      +/-   ##
==========================================
- Coverage   64.64%   64.53%   -0.11%     
==========================================
  Files         187      187              
  Lines       19712    19712              
==========================================
- Hits        12742    12722      -20     
- Misses       6970     6990      +20     
Files with missing lines Coverage Δ
crates/bridge-sig-manager/src/errors.rs 100.00% <ø> (ø)
crates/bridge-sig-manager/src/manager.rs 98.41% <ø> (ø)
crates/bridge-tx-builder/src/context.rs 100.00% <ø> (ø)
crates/bridge-tx-builder/src/deposit.rs 97.44% <ø> (ø)
crates/bridge-tx-builder/src/errors.rs 12.50% <ø> (ø)
crates/bridge-tx-builder/src/operations.rs 96.51% <ø> (ø)
crates/btcio/src/inscription.rs 93.96% <ø> (ø)
crates/btcio/src/rpc/error.rs 0.00% <ø> (ø)
crates/consensus-logic/src/state_tracker.rs 46.40% <ø> (ø)
crates/db/src/entities/bridge_tx_state.rs 96.61% <ø> (ø)
... and 13 more

... and 1 file with indirect coverage changes

@storopoli storopoli self-assigned this Sep 19, 2024
@storopoli storopoli added documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code labels Sep 19, 2024
@storopoli storopoli requested a review from Rajil1213 September 19, 2024 19:02
@storopoli storopoli marked this pull request as ready for review September 19, 2024 19:02
@storopoli
Copy link
Member Author

Hey I've added 0.01% in the code coverage without touching code :)
The magic of good documentation 🪄

Copy link
Contributor

@Rajil1213 Rajil1213 left a comment

Choose a reason for hiding this comment

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

Approving these changes as the functional tests were already broken. But we might want to merge this once those are fixed and this branch has been rebased.

@storopoli storopoli merged commit 6cb55af into master Sep 19, 2024
17 of 19 checks passed
@storopoli storopoli deleted the storopoli/fix-docs branch September 19, 2024 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants