GrowTogetherAPI/.github/workflows/docs.yml at main · devPatuel/GrowTogetherAPI · GitHub

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
name: Generar y publicar Javadoc

on:
  push:
    branches: [main]
    paths:
      - 'GrowTogetherAPI/src/**'
      - 'GrowTogetherAPI/build.gradle.kts'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build-docs:
    name: Generar Javadoc
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Java 17
        uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: '17'

      - name: Permisos gradlew
        working-directory: GrowTogetherAPI
        run: chmod +x gradlew

      - name: Generar Javadoc
        working-directory: GrowTogetherAPI
        run: ./gradlew javadoc -Dorg.gradle.jvmargs="-Xmx2g" --no-daemon
        env:
          # Silencia validaciones estrictas de Javadoc (@param, @return, etc.)
          # para que los comentarios existentes no rompan el build
          JAVA_TOOL_OPTIONS: "-Duser.language=es"

      - name: Subir Javadoc como artifact descargable
        uses: actions/upload-artifact@v4
        with:
          name: javadoc-html
          path: GrowTogetherAPI/build/docs/javadoc/
          retention-days: 30

      - name: Preparar artifact para GitHub Pages
        uses: actions/upload-pages-artifact@v3
        with:
          path: GrowTogetherAPI/build/docs/javadoc/

  deploy-pages:
    name: Desplegar a GitHub Pages
    needs: build-docs
    runs-on: ubuntu-latest
    # continue-on-error evita que el workflow falle si Pages aun no esta habilitado
    # (repo privado sin GitHub Pro). El artifact del job anterior sigue disponible.
    continue-on-error: true
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy
        id: deployment
        uses: actions/deploy-pages@v4