ci.yml

name: CI

on:
  push:
    branches: [main]
    tags: ['[0-9]*.[0-9]*.[0-9]*']
  pull_request:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'
          cache: 'maven'
      - run: mvn -B verify

  release:
    needs: build
    runs-on: ubuntu-latest
    if: startsWith(github.ref, 'refs/tags/')
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
      - name: Create GitHub Release
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          awk "/^## \[${GITHUB_REF_NAME}\]/{found=1; next} found && /^## \[/{exit} found{print}" \
            CHANGELOG.md > /tmp/release-notes.md
          gh release create "$GITHUB_REF_NAME" \
            --title "$GITHUB_REF_NAME" \
            --notes-file /tmp/release-notes.md

  # Attaches the generated documentation to the release, for the QTSurfer website to publish.
  reference-docs:
    needs: release
    if: startsWith(github.ref, 'refs/tags/')
    permissions:
      contents: write
    uses: ./.github/workflows/reference-docs.yml
    with:
      tag: ${{ github.ref_name }}

  docs:
    needs: build
    runs-on: ubuntu-latest
    # Only tagged versions get published, so the site always describes a release
    # rather than whatever main happens to be.
    if: startsWith(github.ref, 'refs/tags/')
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deploy.outputs.page_url }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'
          cache: 'maven'
      # These sources are generated from the spec, so they have to exist before
      # javadoc can read them.
      - name: Generate javadoc
        run: mvn -B generate-sources javadoc:javadoc
      - uses: actions/configure-pages@v5
      - uses: actions/upload-pages-artifact@v3
        with:
          path: target/site/apidocs
      - id: deploy
        uses: actions/deploy-pages@v4