Skip to content

Commit

Permalink
Fix rust docs deploy (#2615)
Browse files Browse the repository at this point in the history
<!--
Open the PR up as a draft until you feel it is ready for a proper
review.

Do not make PR:s from your own `main` branch, as that makes it difficult
for reviewers to add their own fixes.

Add any improvements to the branch as new commits to make it easier for
reviewers to follow the progress. All commits will be squashed to a
single commit once the PR is merged into `main`.

Make sure you mention any issues that this PR closes in the description,
as well as any other related issues.

To get an auto-generated PR description you can put "copilot:summary" or
"copilot:walkthrough" anywhere.
-->

### What

Remove the `/target/doc` directory before building and deploying docs.
This should fix the rust docs deploy issue, but it will be unconfirmed
until we merge into main

Also removes the `files.exclude` vscode setting for already gitignored
directories. I keep having to dig into target dirs and/or the venv and
it's pretty annoying to keep this change around locally inbetween all
the git checkouts. I don't see why we need it in the first place, it
just removes the files from the explorer pane. That makes it a bit
shorter, but not by a lot.

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/2615) (if
applicable)

- [PR Build Summary](https://build.rerun.io/pr/2615)
- [Docs
preview](https://rerun.io/preview/pr%3Ajan%2Ffix-deploy-docs/docs)
- [Examples
preview](https://rerun.io/preview/pr%3Ajan%2Ffix-deploy-docs/examples)
  • Loading branch information
jprochazk committed Jul 6, 2023
1 parent e76ebd9 commit d23f1e4
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions .github/workflows/reusable_deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'Reusable Deploy Docs'
name: "Reusable Deploy Docs"

on:
workflow_call:
Expand Down Expand Up @@ -33,8 +33,7 @@ env:
RUSTC_WRAPPER: "sccache"

jobs:

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

py-deploy-docs:
name: Python
Expand Down Expand Up @@ -90,8 +89,7 @@ jobs:
git commit -m "Update docs for ${GITHUB_SHA}"
git push origin gh-pages-orphan:gh-pages -f
# ---------------------------------------------------------------------------
# ---------------------------------------------------------------------------

rs-deploy-docs:
name: Rust
Expand Down Expand Up @@ -129,6 +127,9 @@ jobs:
- name: Run sccache-cache
uses: mozilla-actions/sccache-action@v0.0.3

- name: Delete existing /target/doc
run: rm -rf ./target/doc

- name: cargo doc --document-private-items
uses: actions-rs/cargo@v1
with:
Expand Down Expand Up @@ -156,3 +157,4 @@ jobs:
run: |
git fetch
python3 -m ghp_import -n -p -x docs/rust/head target/doc/ -m "Update the rust docs"

0 comments on commit d23f1e4

Please sign in to comment.