add basic CI for generic tests#4
Conversation
9612a1f to
c6925ed
Compare
There was a problem hiding this comment.
Pull request overview
Adds a basic GitHub Actions workflow to build/test the workspace on Linux and optionally generate & publish Rust docs to GitHub Pages, alongside a small cleanup in the oneapi-rs-sys build script.
Changes:
- Introduces
.github/workflows/basic.ymlto install oneAPI, build, run tests, and (optionally) generate + deploycargo docoutput to GitHub Pages. - Adjusts
oneapi-rs-sys/build.rsformatting and stops explicitly linkingze_loader(now commented out).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
oneapi-rs-sys/build.rs |
Minor build-script cleanup and link directive adjustment. |
.github/workflows/basic.yml |
New CI workflow for build/test plus on-demand docs generation and Pages deployment. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
The workflow seems alright, although the final URL looks redundant because the website hosts the docs for two crates:
Currently there's no way for end users to access oneapi-rs-sys docs apart from entering that URL manually. That crate doesn't have any custom docs either, just like other cxx -sys crates. Maybe we should only publish the oneapi-rs docs and ignore the sys crate? This would simplify the URL.
| - name: Add documentation landing page | ||
| if: github.event_name == 'workflow_dispatch' && inputs.generate_documentation | ||
| run: | | ||
| cat > target/doc/index.html <<'HTML' | ||
| <!doctype html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="refresh" content="0; url=oneapi_rs/"> | ||
| <title>oneapi-rs documentation</title> | ||
| </head> | ||
| <body> | ||
| <p><a href="oneapi_rs/">oneapi-rs documentation</a></p> | ||
| </body> | ||
| </html> | ||
| HTML |
There was a problem hiding this comment.
Currently there's no way to access oneapi-rs-sys docs.
There was a problem hiding this comment.
now only documentation for oneapi-rs is generated
|
|
||
| println!("cargo::rustc-link-lib=sycl"); | ||
| println!("cargo::rustc-link-lib=ze_loader"); | ||
| // println!("cargo::rustc-link-lib=ze_loader"); |
There was a problem hiding this comment.
This comment isn't necessary.
431c59f to
f1ff86c
Compare
f1ff86c to
11e8a2c
Compare
11e8a2c to
6cfa626
Compare
szymon-zadworny
left a comment
szymon-zadworny
left a comment
There was a problem hiding this comment.
lgtm, we can merge this
add basic CI for generic tests and docs generation
example of docs: https://bratpiorka.github.io/oneapi-rs
NOTE: Temporarily disable linking to libze_loader, as it is not installed on generic GitHub machines.