1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
sap-jenkins-library/.github/workflows/documentation.yml
renovate[bot] f58bc66ae1
chore(deps): update actions/setup-java action to v4 (#4709)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Jordi van Liempt <35920075+jliempt@users.noreply.github.com>
2023-12-05 12:19:40 +01:00

79 lines
2.2 KiB
YAML

name: Documentation
on:
push:
branches:
- master
pull_request:
branches:
- master
jobs:
Build:
runs-on: ubuntu-latest
steps:
- uses: styfle/cancel-workflow-action@0.11.0
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
java-version: 8
distribution: zulu
- uses: actions/setup-go@v4
with:
go-version: '1.19.x'
- name: Install Groovy
run: sudo apt-get update && sudo apt-get install groovy -y
- name: Cache Maven Packages
uses: actions/cache@v3
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
- name: Cache Go Packages
uses: actions/cache@v3
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- run: docker pull ppiper/jenkinsfile-runner:latest
- name: Generate Groovy Docs
env:
MAVEN_OPTS: -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn
run: documentation/bin/createDocu.sh
- name: Generate Golang Docs
run: go run pkg/documentation/generator.go --docuDir=documentation/docs/steps/ --customDefaultFile resources/default_pipeline_environment.yml
- name: Build
run: |
docker run \
-u $(id -u):$(id -g) \
-v ${GITHUB_WORKSPACE}/documentation:/docs \
squidfunk/mkdocs-material:8.5.11 build --clean --strict
- name: Provide Docs Metadata
run: |
mkdir -p documentation/docs-gen/misc
cp target/docuMetaData.json documentation/docs-gen/misc
- name: Deploy
if: github.ref == 'refs/heads/master'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./documentation/docs-gen
user_name: 'github-actions[bot]'
user_email: '41898282+github-actions[bot]@users.noreply.github.com'
keep_files: true
force_orphan: true