FilesExpand file tree

 main

/

github-pages.yaml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

92 lines (85 loc) · 2.77 KB

 main

/

github-pages.yaml

Copy path

Top

File metadata and controls

• Code
• Blame

92 lines (85 loc) · 2.77 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

name: Deploy Documentation to Github Pages

on:

# Runs on pushes targeting the 1.0.x branch

push:

branches:

- main

tags:

- "v*.*.*" # updates the version in the docs

# Allows you to run this workflow manually from the Actions tab

workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages

permissions:

contents: read

pages: write

id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.

# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.

concurrency:

group: "pages"

cancel-in-progress: false

# Default to bash

defaults:

run:

shell: bash

jobs:

# Build job

build:

runs-on: ubuntu-24.04

env:

HUGO_VERSION: 0.115.4

steps:

- uses: actions/checkout@v4

with:

fetch-tags: 'true'

fetch-depth: 0

- name: Set up JDK

uses: actions/setup-java@v4

with:

java-version: 17

distribution: temurin

cache: 'maven'

- name: Set release version

run: ./scripts/set-release-version-github-pages.sh

- name: Install Hugo CLI

run: |

wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \

&& sudo dpkg -i ${{ runner.temp }}/hugo.deb

- name: Make Javadoc

run: ./mvnw -B clean compile javadoc:javadoc javadoc:aggregate -P javadoc

- name: Move the Javadoc to docs/static/api/

run: mv ./target/reports/apidocs ./docs/static/api && echo && echo 'ls ./docs/static/api' && ls ./docs/static/api

- name: Setup Pages

id: pages

uses: actions/configure-pages@v5

- name: Install Node.js dependencies

run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"

working-directory: ./docs

- name: Build with Hugo

env:

# For maximum backward compatibility with Hugo modules

HUGO_ENVIRONMENT: production

HUGO_ENV: production

run: |

hugo \

--gc \

--minify \

--baseURL "${{ steps.pages.outputs.base_url }}/"

working-directory: ./docs

- name: ls ./docs/public/api

run: echo 'ls ./docs/public/api' && ls ./docs/public/api

- name: Upload artifact

uses: actions/upload-pages-artifact@v3

with:

path: ./docs/public

# Deployment job

deploy:

environment:

name: github-pages

url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-24.04

needs: build

steps:

- name: Deploy to GitHub Pages

id: deployment

uses: actions/deploy-pages@v4