Skip to content

add CI/CD for documentation#45

Merged
xarantolus merged 6 commits intomainfrom
docs-ci
Apr 6, 2026
Merged

add CI/CD for documentation#45
xarantolus merged 6 commits intomainfrom
docs-ci

Conversation

@gkuznik
Copy link
Copy Markdown
Member

@gkuznik gkuznik commented Apr 2, 2026

No description provided.

Comment thread .github/workflows/ci.yml Fixed
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a static website landing page and a GitHub Actions job intended to generate Rust docs and deploy them to GitHub Pages.

Changes:

  • Added website/index.html as a documentation landing page.
  • Added a docs job to .github/workflows/ci.yml to build Rust docs and deploy the website/ directory to GitHub Pages.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.

File Description
website/index.html New static homepage with links to source and documentation.
.github/workflows/ci.yml Adds a docs build + GitHub Pages deployment job.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread website/index.html Outdated
Comment thread .github/workflows/ci.yml Outdated
Comment thread .github/workflows/ci.yml
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

LCOV of commit 1f73d71 during Osiris CI #461

This pull request changes total coverage 0.00% (25.83% -> 25.83%) for this diff

lcov: WARNING: lcov: WARNING: RC option 'lcov_branch_coverage' is deprecated.  Consider using 'branch_coverage. instead.  (Backward-compatible support will be removed in the future
Summary coverage rate:
  lines......: 25.8% (711 of 2753 lines)
  functions..: 18.1% (70 of 387 functions)
  branches...: no data found

Files changed coverage rate: n/a

Comment thread .github/workflows/ci.yml Fixed
gkuznik added 4 commits April 6, 2026 21:59
automatically builds the docs and deploys the default branch
fix duplicate action runs
Copy link
Copy Markdown
Member

@thomasw04 thomasw04 left a comment

Choose a reason for hiding this comment

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

lgtm!

Comment thread .github/workflows/ci.yml Outdated
run: just config load stm32l4r5zi_def --no-confirm

- name: Generate docs
run: cargo doc --no-deps --workspace
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe use cargo doc --document-private-items --examples --release --bins --no-deps --workspace to document even more things?

@xarantolus xarantolus merged commit 6940b3c into main Apr 6, 2026
2 of 3 checks passed
@xarantolus xarantolus deleted the docs-ci branch April 6, 2026 20:19
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.

5 participants