forked from TimelyDataflow/differential-dataflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for CI (TimelyDataflow#373)
- Loading branch information
Showing
25 changed files
with
315 additions
and
134 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: deploy | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- run: cargo install mdbook --version 0.4.31 | ||
- run: cd mdbook && mdbook build | ||
- uses: JamesIves/github-pages-deploy-action@v4 | ||
with: | ||
branch: gh-pages | ||
folder: mdbook/book |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: test | ||
|
||
on: [push, pull_request] | ||
|
||
jobs: | ||
test: | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- run: rustup update 1.70 --no-self-update && rustup default 1.70 | ||
- run: cargo build | ||
- name: test mdBook | ||
# rustdoc doesn't build dependencies, so it needs to run after `cargo build`, | ||
# but its dependency search gets confused if there are multiple copies of any | ||
# dependency in target/debug/deps, so it needs to run before `cargo test` et al. | ||
# clutter target/debug/deps with multiple copies of things. | ||
run: for file in $(find mdbook -name '*.md' | sort); do rustdoc --test $file -L ./target/debug/deps; done | ||
- run: cargo test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,34 +4,39 @@ The first thing you will need to do, if you want to follow along with the exampl | |
|
||
With Rust in hand, crack open a shell and make a new project using Rust build manager `cargo`. | ||
|
||
Echidnatron% cargo new my_project | ||
```shell | ||
cargo new my_project | ||
``` | ||
|
||
This should create a new folder called `my_project`, and you can wander in there and type | ||
|
||
Echidnatron% cargo run | ||
```shell | ||
cargo run | ||
``` | ||
|
||
This will do something reassuring but pointless, like print `Hello, world!`, because we haven't gotten differential dataflow involved yet. I mean, it's Rust and you could learn that, but you probably want to read a different web page in that case. | ||
|
||
Instead, edit your `Cargo.toml` file, which tells Rust about your dependencies, to look like this: | ||
|
||
Echidnatron% cat Cargo.toml | ||
[package] | ||
name = "my_project" | ||
version = "0.1.0" | ||
authors = ["Your Name <[email protected]>"] | ||
```toml | ||
[package] | ||
name = "my_project" | ||
version = "0.1.0" | ||
authors = ["Your Name <[email protected]>"] | ||
|
||
[dependencies] | ||
timely = "0.11.1" | ||
differential-dataflow = "0.11.0" | ||
Echidnatron% | ||
[dependencies] | ||
timely = "0.11.1" | ||
differential-dataflow = "0.11.0" | ||
``` | ||
|
||
You should only need to add those last two lines there, which bring in dependencies on both [timely dataflow](https://github.com/TimelyDataflow/timely-dataflow) and [differential dataflow](https://github.com/TimelyDataflow/differential-dataflow). We will be using both of those. | ||
|
||
If you would like to point at the most current code release, hosted on github, you can replace the dependencies with: | ||
|
||
[dependencies] | ||
timely = { git = "https://github.com/TimelyDataflow/timely-dataflow" } | ||
differential-dataflow = { git = "https://github.com/TimelyDataflow/differential-dataflow" } | ||
|
||
```toml | ||
[dependencies] | ||
timely = { git = "https://github.com/TimelyDataflow/timely-dataflow" } | ||
differential-dataflow = { git = "https://github.com/TimelyDataflow/differential-dataflow" } | ||
``` | ||
|
||
You should now be ready to go. Code examples should mostly work, and you should complain (or [file an issue](https://github.com/TimelyDataflow/differential-dataflow/issues)) if they do not! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.