Skip to content

Commit

Permalink
On push sync the docs to gh-pages (#1086)
Browse files Browse the repository at this point in the history
* New workflow for building & deploying the rust-docs
* Only update the docs on push to main
  • Loading branch information
jleibs committed Feb 6, 2023
1 parent 0a3e8bb commit 7aaedbf
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,9 @@ jobs:
RUSTFLAGS: ${{env.RUSTFLAGS}}
RUSTDOCFLAGS: ${{env.RUSTDOCFLAGS}}
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
fetch-depth: 0 # Don't do a shallow clone since we need to push gh-pages

- name: Set up cargo cache
uses: Swatinem/rust-cache@v2
Expand Down Expand Up @@ -149,6 +151,30 @@ jobs:
command: test
args: --all-targets --all-features

- name: Set up git author
if: ${{ github.event_name == 'push' }}
run: |
remote_repo="https://${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
git config --global user.name "${GITHUB_ACTOR}"
git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Set up ghp-import
if: ${{ github.event_name == 'push' }}
run: pip install ghp-import

- name: Patch in a redirect page
if: ${{ github.event_name == 'push' }}
run: echo "<meta http-equiv=\"refresh\" content=\"0; url=${REDIRECT_CRATE}\">" > target/doc/index.html
env:
REDIRECT_CRATE: rerun_sdk

# See: https://github.com/c-w/ghp-import
- name: Deploy the docs
if: ${{ github.event_name == 'push' }}
run: python3 -m ghp_import -n -p -x rust/head target/doc/ -m "Update the rust docs"

# ---------------------------------------------------------------------------

rs-check-wasm:
Expand Down

1 comment on commit 7aaedbf

@github-actions
Copy link

Choose a reason for hiding this comment

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

Rust Benchmark

Benchmark suite Current: 7aaedbf Previous: 0a3e8bb Ratio
datastore/insert/batch/rects/insert 578949 ns/iter (± 1704) 576060 ns/iter (± 6290) 1.01
datastore/latest_at/batch/rects/query 1804 ns/iter (± 0) 1778 ns/iter (± 1) 1.01
datastore/latest_at/missing_components/primary 352 ns/iter (± 0) 351 ns/iter (± 2) 1.00
datastore/latest_at/missing_components/secondaries 425 ns/iter (± 0) 424 ns/iter (± 0) 1.00
datastore/range/batch/rects/query 153067 ns/iter (± 237) 152353 ns/iter (± 216) 1.00
mono_points_arrow/generate_message_bundles 49448217 ns/iter (± 1214609) 46084085 ns/iter (± 1467421) 1.07
mono_points_arrow/generate_messages 136639765 ns/iter (± 2870063) 137843492 ns/iter (± 2457453) 0.99
mono_points_arrow/encode_log_msg 166587802 ns/iter (± 1171355) 165919594 ns/iter (± 866154) 1.00
mono_points_arrow/encode_total 352091936 ns/iter (± 3107043) 352620315 ns/iter (± 5980745) 1.00
mono_points_arrow/decode_log_msg 183941706 ns/iter (± 2230011) 183983622 ns/iter (± 2899224) 1.00
mono_points_arrow/decode_message_bundles 73566526 ns/iter (± 2588873) 73332778 ns/iter (± 931439) 1.00
mono_points_arrow/decode_total 256758246 ns/iter (± 1997541) 255737046 ns/iter (± 4518510) 1.00
batch_points_arrow/generate_message_bundles 319665 ns/iter (± 1456) 317801 ns/iter (± 1213) 1.01
batch_points_arrow/generate_messages 6078 ns/iter (± 10) 6096 ns/iter (± 15) 1.00
batch_points_arrow/encode_log_msg 364932 ns/iter (± 2681) 366310 ns/iter (± 1282) 1.00
batch_points_arrow/encode_total 716022 ns/iter (± 5330) 711719 ns/iter (± 2691) 1.01
batch_points_arrow/decode_log_msg 342158 ns/iter (± 1014) 354272 ns/iter (± 1938) 0.97
batch_points_arrow/decode_message_bundles 2063 ns/iter (± 8) 2059 ns/iter (± 5) 1.00
batch_points_arrow/decode_total 360447 ns/iter (± 3156) 354499 ns/iter (± 722) 1.02
arrow_mono_points/insert 6958107805 ns/iter (± 81915776) 6842091184 ns/iter (± 60117528) 1.02
arrow_mono_points/query 1700975 ns/iter (± 15144) 1778314 ns/iter (± 9788) 0.96
arrow_batch_points/insert 2659038 ns/iter (± 9607) 2705341 ns/iter (± 20986) 0.98
arrow_batch_points/query 17052 ns/iter (± 41) 16785 ns/iter (± 252) 1.02
tuid/Tuid::random 34 ns/iter (± 0) 34 ns/iter (± 0) 1

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.