Skip to content

Publish HMPPS Integration API Documentation #18

Publish HMPPS Integration API Documentation

Publish HMPPS Integration API Documentation #18

Workflow file for this run

name: Publish HMPPS Integration API Documentation
on:
workflow_dispatch:
push:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
java-version: '21'
distribution: 'temurin'
- uses: gradle/actions/setup-gradle@v4
- name: Serve dependencies
run: make serve-dependencies
- name: Start service
run: |
./gradlew bootRun &
timeout 300 sh -c 'until curl -s localhost:8080/v3/api-docs; do sleep 5; done'
env:
SPRING_PROFILES_ACTIVE: local
- uses: ruby/setup-ruby@v1
with:
ruby-version: 3.1
bundler-cache: true
working-directory: tech-docs
- name: Build
run: |
gem install middleman
bundle exec middleman build --verbose
working-directory: tech-docs
- name: Bundle OpenAPI specs
run: |
curl -sf localhost:8080/v3/api-docs -o api-docs.json
working-directory: tech-docs/build
- uses: actions/upload-artifact@v4
with:
name: documentation
path: tech-docs/build
deploy:
runs-on: ubuntu-latest
if: github.ref_name == 'main' || (github.event_name == 'workflow_dispatch')
needs:
- build
steps:
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with:
name: documentation
- name: Deploy
uses: JamesIves/github-pages-deploy-action@920cbb300dcd3f0568dbc42700c61e2fd9e6139c # v4.6.4
with:
folder: tech-docs/build
target-folder: /