Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS][CI] Auto push docs to the website branch #1305

Merged
merged 15 commits into from
Apr 3, 2024
49 changes: 29 additions & 20 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,13 @@ on:
push:
branches:
- master
paths:
- 'docs/**'
- 'docs-overrides/**'
- 'mkdocs.yml'
- 'R/**'

pull_request:
branches:
- '*'
paths:
- 'docs/**'
- 'docs-overrides/**'
- 'mkdocs.yml'
- 'R/**'

env:
MAVEN_OPTS: -Dmaven.wagon.httpconnectionManager.ttlSeconds=60

jobs:
build:
Expand All @@ -24,6 +18,14 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Java
uses: actions/setup-java@v1
with:
java-version: '11'
- name: Compile JavaDoc
run: mvn -q clean install -DskipTests && mkdir -p docs/api/javadoc/spark && cp spark/common/target/apidocs/* docs/api/javadoc/spark/
- name: Compile ScalaDoc
run: mvn scala:doc && mkdir -p docs/api/scaladoc/spark && cp spark/common/target/site/scaladocs/* docs/api/scaladoc/spark
- uses: actions/setup-python@v5
with:
python-version: 3.x
Expand All @@ -44,19 +46,26 @@ jobs:
any::pkgdown
working-directory : './R'
- run: Rscript -e 'pkgdown::build_site(pkg = "./R", preview = FALSE, override = list(destination = "../docs/api/rdocs"))'
- uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-

- run: git config --global user.name = "test-name"
- run: git config --global user.email = "test-email@abc.com"
- run: mike deploy --update-aliases current-snapshot
- run: git config --global user.name = "GitHub Action"
- run: git config --global user.email = "test@abc.com"
- run: mkdocs build
- run: mike deploy latest-snapshot -b website -p
- run: mkdir staging
- run: cp -r site/* staging/
- uses: actions/upload-artifact@v3
with:
name: generated-docs
path: staging
- name: Cache Python packages
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Cache Maven packages
uses: actions/cache@v3
with:
path: ~/.m2
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
restore-keys: ${{ runner.os }}-m2
jiayuasu marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 1 addition & 3 deletions docs/community/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ You can participate in the community as follows:

## Community events

Everyone is welcome to join our community events. We have a community office hour every 4 weeks.

<iframe src="https://calendar.google.com/calendar/embed?src=c_ef7d54f5308a4b7f25ac33d0f7eeb54a3a7f115b689faf4d82425f3cb5ede935%40group.calendar.google.com&ctz=America%2FLos_Angeles" style="border: 0" width="800" height="600" frameborder="0" scrolling="no"></iframe>
Everyone is welcome to join our community events. We have a community office hour every 4 weeks. Please import the event to your [Google Calendar](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NjI0cWgwcTZndnI1anAzYnFrNHY5Y2wyaTRfMjAyNDA0MDlUMTUwMDAwWiBjX2VmN2Q1NGY1MzA4YTRiN2YyNWFjMzNkMGY3ZWViNTRhM2E3ZjExNWI2ODlmYWY0ZDgyNDI1ZjNjYjVlZGU5MzVAZw&tmsrc=c_ef7d54f5308a4b7f25ac33d0f7eeb54a3a7f115b689faf4d82425f3cb5ede935%40group.calendar.google.com&scp=ALL).

## Twitter

Expand Down
Loading