docs: move to gh pages (#30242)
* mv to pages
* cleanup
* push static
* mv that
* new name for the orphan
* only master
* build op
old-commit-hash: f8a7def515
testing-closet
parent
c3aa58b492
commit
4866e8376b
5 changed files with 62 additions and 78 deletions
@ -0,0 +1,62 @@ |
|||||||
|
name: docs |
||||||
|
|
||||||
|
on: |
||||||
|
push: |
||||||
|
branches: |
||||||
|
- master |
||||||
|
pull_request: |
||||||
|
|
||||||
|
concurrency: |
||||||
|
group: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && github.run_id || github.head_ref || github.ref }}-${{ github.workflow }}-${{ github.event_name }} |
||||||
|
cancel-in-progress: true |
||||||
|
|
||||||
|
env: |
||||||
|
BASE_IMAGE: openpilot-base |
||||||
|
|
||||||
|
BUILD: selfdrive/test/docker_build.sh base |
||||||
|
|
||||||
|
RUN: docker run --shm-size 1G -v $GITHUB_WORKSPACE:/tmp/openpilot -w /tmp/openpilot -e FILEREADER_CACHE=1 -e PYTHONPATH=/tmp/openpilot -e NUM_JOBS -e JOB_ID -e GITHUB_ACTION -e GITHUB_REF -e GITHUB_HEAD_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_RUN_ID -v $GITHUB_WORKSPACE/.ci_cache/scons_cache:/tmp/scons_cache -v $GITHUB_WORKSPACE/.ci_cache/comma_download_cache:/tmp/comma_download_cache -v $GITHUB_WORKSPACE/.ci_cache/openpilot_cache:/tmp/openpilot_cache $BASE_IMAGE /bin/sh -c |
||||||
|
|
||||||
|
jobs: |
||||||
|
docs: |
||||||
|
name: build docs |
||||||
|
runs-on: ubuntu-20.04 |
||||||
|
timeout-minutes: 45 |
||||||
|
steps: |
||||||
|
- uses: actions/checkout@v4 |
||||||
|
with: |
||||||
|
submodules: true |
||||||
|
- uses: ./.github/workflows/setup-with-retry |
||||||
|
- name: Build openpilot |
||||||
|
run: | |
||||||
|
${{ env.RUN }} "scons -j$(nproc)" |
||||||
|
- name: Build docs |
||||||
|
run: | |
||||||
|
${{ env.RUN }} "apt update && apt install -y doxygen && cd docs && make html" |
||||||
|
|
||||||
|
- uses: actions/checkout@v4 |
||||||
|
if: github.ref == 'refs/heads/master' && github.repository == 'commaai/openpilot' |
||||||
|
with: |
||||||
|
path: openpilot-docs |
||||||
|
ssh-key: ${{ secrets.OPENPILOT_DOCS_KEY }} |
||||||
|
repository: commaai/openpilot-docs |
||||||
|
- name: Push |
||||||
|
if: github.ref == 'refs/heads/master' && github.repository == 'commaai/openpilot' |
||||||
|
run: | |
||||||
|
set -x |
||||||
|
|
||||||
|
source release/identity.sh |
||||||
|
|
||||||
|
cd openpilot-docs |
||||||
|
|
||||||
|
git checkout --orphan tmp |
||||||
|
git rm -rf --cached . |
||||||
|
|
||||||
|
cp -r ../build/docs/html/ docs/ |
||||||
|
touch docs/.nojekyll |
||||||
|
git add -f . |
||||||
|
|
||||||
|
git commit -m "build docs" |
||||||
|
|
||||||
|
# docs live in different repo to not bloat openpilot's full clone size |
||||||
|
git push -f origin gh-pages |
@ -1,42 +0,0 @@ |
|||||||
FROM ghcr.io/commaai/openpilot-base:latest |
|
||||||
|
|
||||||
ENV PYTHONUNBUFFERED 1 |
|
||||||
|
|
||||||
ENV OPENPILOT_PATH /tmp/openpilot |
|
||||||
ENV PYTHONPATH ${OPENPILOT_PATH}:${PYTHONPATH} |
|
||||||
ENV POETRY_VIRUALENVS_CREATE false |
|
||||||
|
|
||||||
RUN mkdir -p ${OPENPILOT_PATH} |
|
||||||
WORKDIR ${OPENPILOT_PATH} |
|
||||||
|
|
||||||
COPY SConstruct ${OPENPILOT_PATH} |
|
||||||
|
|
||||||
COPY ./openpilot ${OPENPILOT_PATH}/openpilot |
|
||||||
COPY ./body ${OPENPILOT_PATH}/body |
|
||||||
COPY ./third_party ${OPENPILOT_PATH}/third_party |
|
||||||
COPY ./site_scons ${OPENPILOT_PATH}/site_scons |
|
||||||
COPY ./laika_repo ${OPENPILOT_PATH}/laika_repo |
|
||||||
RUN ln -s ${OPENPILOT_PATH}/laika_repo/laika/ ${OPENPILOT_PATH}/laika |
|
||||||
COPY ./rednose ${OPENPILOT_PATH}/rednose |
|
||||||
COPY ./rednose_repo ${OPENPILOT_PATH}/rednose_repo |
|
||||||
COPY ./tools ${OPENPILOT_PATH}/tools |
|
||||||
COPY ./release ${OPENPILOT_PATH}/release |
|
||||||
COPY ./common ${OPENPILOT_PATH}/common |
|
||||||
COPY ./opendbc ${OPENPILOT_PATH}/opendbc |
|
||||||
COPY ./cereal ${OPENPILOT_PATH}/cereal |
|
||||||
COPY ./panda ${OPENPILOT_PATH}/panda |
|
||||||
COPY ./selfdrive ${OPENPILOT_PATH}/selfdrive |
|
||||||
COPY ./system ${OPENPILOT_PATH}/system |
|
||||||
COPY ./*.md ${OPENPILOT_PATH}/ |
|
||||||
|
|
||||||
RUN --mount=type=bind,source=.ci_cache/scons_cache,target=/tmp/scons_cache,rw scons -j$(nproc) --cache-readonly |
|
||||||
|
|
||||||
RUN apt update && apt install doxygen -y |
|
||||||
COPY ./docs ${OPENPILOT_PATH}/docs |
|
||||||
RUN git init . |
|
||||||
WORKDIR ${OPENPILOT_PATH}/docs |
|
||||||
RUN make html |
|
||||||
|
|
||||||
FROM nginx:1.21 |
|
||||||
COPY --from=0 /tmp/openpilot/build/docs/html /usr/share/nginx/html |
|
||||||
COPY ./docs/docker/nginx.conf /etc/nginx/conf.d/default.conf |
|
@ -1,15 +0,0 @@ |
|||||||
server { |
|
||||||
listen 80; |
|
||||||
listen [::]:80; |
|
||||||
server_name localhost; |
|
||||||
|
|
||||||
gzip on; |
|
||||||
gzip_types text/html text/plain text/css text/xml text/javascript application/javascript application/x-javascript; |
|
||||||
gzip_min_length 1024; |
|
||||||
gzip_vary on; |
|
||||||
|
|
||||||
root /usr/share/nginx/html; |
|
||||||
location / { |
|
||||||
try_files $uri $uri/ /index.html; |
|
||||||
} |
|
||||||
} |
|
Loading…
Reference in new issue