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.

Sign up for GitHub

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

HPCC-32137 PR test for documentation builds #18858

Merged
merged 1 commit into from
Oct 4, 2024
Merged

HPCC-32137 PR test for documentation builds #18858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/build-vcpkg.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,36 @@ jobs:
asset-name: 'docker-ubuntu-22_04'
secrets: inherit

check-documentation-changes:
if: ${{ contains('pull_request,push', github.event_name) }}
runs-on: ubuntu-22.04
outputs:
documentation_contents_changed: ${{ steps.variables.outputs.documentation_contents_changed }}
steps:
- name: Check for Documentation Changes
id: changed
uses: dorny/paths-filter@v3
with:
filters: |
src:
- 'docs/**'
GordonSmith marked this conversation as resolved.
Show resolved Hide resolved
- '.github/workflows/test-documentation.yml'
- name: Set Output
id: variables
run: |
echo "documentation_contents_changed=${{ steps.changed.outputs.src }}" >> $GITHUB_OUTPUT
- name: Print Variables
run: |
echo "${{ toJSON(steps.variables.outputs)}}"
Michael-Gardner marked this conversation as resolved.
Show resolved Hide resolved

test-documentation-ubuntu-22_04:
needs: check-documentation-changes
if: ${{ contains('pull_request,push', github.event_name) && needs.check-documentation-changes.outputs.documentation_contents_changed == 'true' }}
uses: ./.github/workflows/test-documentation.yml
with:
os: 'ubuntu-22.04'
asset-name: 'Documentation'

build-docker-ubuntu-20_04:
if: ${{ contains('schedule,push', github.event_name) }}
uses: ./.github/workflows/build-docker.yml
Expand Down
108 changes: 108 additions & 0 deletions .github/workflows/test-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
name: Build Documentation

on:
workflow_call:
inputs:
os:
type: string
description: 'Operating System'
required: false
default: 'ubuntu-22.04'
asset-name:
type: string
description: 'Asset Name'
required: false
default: 'Documentation'

workflow_dispatch:
inputs:
os:
type: string
description: 'Operating System'
required: false
default: 'ubuntu-22.04'
asset-name:
type: string
description: 'Asset Name'
required: false
default: 'Documentation'

jobs:
build-documentation:
name: Build Documentation
runs-on: ubuntu-22.04

steps:
- name: Checkout HPCC-Platform
uses: actions/checkout@v4
with:
ref: ${{ github.ref }}
submodules: recursive
path: ${{ github.workspace }}/HPCC-Platform

- name: Calculate vars
id: vars
working-directory: ${{ github.workspace }}/HPCC-Platform/vcpkg
run: |
vcpkg_sha_short=$(git rev-parse --short=8 HEAD)
echo "vcpkg_sha_short=$vcpkg_sha_short" >> $GITHUB_OUTPUT
docker_build_label=hpccsystems/platform-build-${{ inputs.os }}
echo "docker_build_label=$docker_build_label" >> $GITHUB_OUTPUT
echo "docker_tag=$docker_build_label:$vcpkg_sha_short" >> $GITHUB_OUTPUT
community_base_ref=${{ github.event.base_ref || github.ref }}
candidate_branch=$(echo $community_base_ref | cut -d'/' -f3)
candidate_base_branch=$(echo $candidate_branch | awk -F'.' -v OFS='.' '{ $3="x"; print }')
echo "docker_tag_candidate_base=$docker_build_label:$candidate_base_branch" >> $GITHUB_OUTPUT
community_ref=${{ github.ref }}
community_tag=$(echo $community_ref | cut -d'/' -f3)
echo "community_tag=$community_tag" >> $GITHUB_OUTPUT
GordonSmith marked this conversation as resolved.
Show resolved Hide resolved
- name: Print vars
run: |
echo "${{ toJSON(steps.vars.outputs) }})"

- name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@v3

- name: Create Build Image
uses: docker/build-push-action@v5
with:
builder: ${{ steps.buildx.outputs.name }}
file: ${{ github.workspace }}/HPCC-Platform/dockerfiles/vcpkg/${{ inputs.os }}.dockerfile
context: ${{ github.workspace }}/HPCC-Platform/dockerfiles/vcpkg
push: false
load: true
build-args: |
VCPKG_REF=${{ steps.vars.outputs.vcpkg_sha_short }}
tags: |
${{ steps.vars.outputs.docker_tag_candidate_base }}
cache-from: |
type=registry,ref=${{ steps.vars.outputs.docker_tag_candidate_base }}
type=registry,ref=${{ steps.vars.outputs.docker_tag }}
cache-to: type=inline

- name: CMake documentation
run: |
mkdir -p {${{ github.workspace }}/build,EN_US,PT_BR}
docker run --rm --mount source="${{ github.workspace }}/HPCC-Platform",target=/hpcc-dev/HPCC-Platform,type=bind,consistency=cached --mount source="${{ github.workspace }}/build",target=/hpcc-dev/build,type=bind,consistency=cached ${{ steps.vars.outputs.docker_tag_candidate_base }} "\
cmake -S /hpcc-dev/HPCC-Platform -B /hpcc-dev/build -DVCPKG_FILES_DIR=/hpcc-dev -DMAKE_DOCS_ONLY=ON -DUSE_NATIVE_LIBRARIES=ON -DDOCS_AUTO=ON -DDOC_LANGS=ALL && \
cmake --build /hpcc-dev/build --parallel $(nproc) --target all"
docker run --rm --mount source="${{ github.workspace }}/HPCC-Platform",target=/hpcc-dev/HPCC-Platform,type=bind,consistency=cached --mount source="${{ github.workspace }}/build",target=/hpcc-dev/build,type=bind,consistency=cached ${{ steps.vars.outputs.docker_tag_candidate_base }} "cd /hpcc-dev/build/Release/docs/EN_US && zip ALL_HPCC_DOCS_EN_US-$(echo '${{ steps.vars.outputs.community_tag }}' | sed 's/community_//' ).zip *.pdf"
docker run --rm --mount source="${{ github.workspace }}/HPCC-Platform",target=/hpcc-dev/HPCC-Platform,type=bind,consistency=cached --mount source="${{ github.workspace }}/build",target=/hpcc-dev/build,type=bind,consistency=cached ${{ steps.vars.outputs.docker_tag_candidate_base }} "cd /hpcc-dev/build/Release/docs/PT_BR && zip ALL_HPCC_DOCS_PT_BR-$(echo '${{ steps.vars.outputs.community_tag }}' | sed 's/community_//' ).zip *.pdf"
- name: Upload build artifacts
uses: actions/upload-artifact@v4
with:
name: ${{ inputs.asset-name }}
path: |
${{ github.workspace }}/build/Release/docs/*.zip
${{ github.workspace }}/build/Release/docs/EN_US/*.zip
${{ github.workspace }}/build/Release/docs/PT_BR/*.zip
${{ github.workspace }}/build/docs/EN_US/EclipseHelp/*.zip
${{ github.workspace }}/build/docs/EN_US/HTMLHelp/*.zip
${{ github.workspace }}/build/docs/PT_BR/HTMLHelp/*.zip
compression-level: 0
Michael-Gardner marked this conversation as resolved.
Show resolved Hide resolved

Loading