-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Split off documentation building into its own pipeline (#7692)
It has occurred to me that the documentation build happens inside the main workflow, which is configured to ignore changes to the docs when determining whether to run. So if a PR only changes the docs... we don't build the docs. That makes no sense. Fix this by extracting the documentation job into its own workflow, that always runs. The downside of this is that we have to duplicate the work of generating the SDK, but IMO, it's an acceptable sacrifice. A side effect of this is that a failure to build the docs no longer prevents the publishing of Docker images, but I don't think that was needed in the first place.
- Loading branch information
Showing
2 changed files
with
67 additions
and
54 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,66 @@ | ||
name: Docs | ||
on: | ||
push: | ||
branches: | ||
- 'master' | ||
- 'develop' | ||
pull_request: | ||
types: [ready_for_review, opened, synchronize, reopened] | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
generate_github_pages: | ||
permissions: | ||
contents: write | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
submodules: recursive | ||
fetch-depth: 0 | ||
|
||
- name: Generate CVAT SDK | ||
run: | | ||
pip3 install --user -r cvat-sdk/gen/requirements.txt | ||
./cvat-sdk/gen/generate.sh | ||
- name: Setup Hugo | ||
run: | | ||
wget https://github.com/gohugoio/hugo/releases/download/v0.110.0/hugo_extended_0.110.0_Linux-64bit.tar.gz | ||
(mkdir hugo_extended_0.110.0_Linux-64bit && tar -xf hugo_extended_0.110.0_Linux-64bit.tar.gz -C hugo_extended_0.110.0_Linux-64bit) | ||
wget https://github.com/gohugoio/hugo/releases/download/v0.83.0/hugo_extended_0.83.0_Linux-64bit.tar.gz | ||
(mkdir hugo_extended_0.83.0_Linux-64bit && tar -xf hugo_extended_0.83.0_Linux-64bit.tar.gz -C hugo_extended_0.83.0_Linux-64bit) | ||
mkdir hugo | ||
cp hugo_extended_0.110.0_Linux-64bit/hugo hugo/hugo-0.110 | ||
cp hugo_extended_0.83.0_Linux-64bit/hugo hugo/hugo-0.83 | ||
- name: Setup Node | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: '18.x' | ||
|
||
- name: Install npm packages | ||
working-directory: ./site | ||
run: | | ||
npm ci | ||
- name: Build docs | ||
run: | | ||
pip install -r site/requirements.txt | ||
python site/process_sdk_docs.py | ||
PATH="$PWD/hugo:$PATH" python site/build_docs.py | ||
env: | ||
HUGO_ENV: production | ||
|
||
- name: Deploy | ||
if: github.ref == 'refs/heads/develop' | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./public | ||
force_orphan: true |
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