|
| 1 | +name: JavaDoc to Documentation Portal |
| 2 | + |
| 3 | +on: |
| 4 | + workflow_dispatch: |
| 5 | + inputs: |
| 6 | + branch: |
| 7 | + description: 'Branch/Commit/Tag for JavaDoc' |
| 8 | + required: true |
| 9 | + default: 'main' |
| 10 | + |
| 11 | +env: |
| 12 | + JAVA_VERSION: 17 |
| 13 | + DOCS_REPO: SAP/cloud-sdk |
| 14 | + PROJECTS: "!:rfc,!:dwc-cf,!:datamodel-metadata-generator,!:odata-generator,!:odata-generator-maven-plugin,!:odata-generator-utility,!:odata-v4-generator,!:odata-v4-generator-maven-plugin,!:s4hana-connectivity,!:soap,!:testutil,!:s4hana-core" |
| 15 | + |
| 16 | +jobs: |
| 17 | + build: |
| 18 | + name: "JavaDoc to Documentation Portal" |
| 19 | + runs-on: ubuntu-latest |
| 20 | + |
| 21 | + steps: |
| 22 | + - name: "Prepare git" |
| 23 | + run: | |
| 24 | + git config --global user.email "[email protected]" |
| 25 | + git config --global user.name "SAP Cloud SDK Bot" |
| 26 | +
|
| 27 | + - name: "Checkout Repository" |
| 28 | + uses: actions/checkout@v4 |
| 29 | + with: |
| 30 | + fetch-depth: 0 |
| 31 | + |
| 32 | + - name: "Switch branch" |
| 33 | + run: git checkout "${{ github.event.inputs.branch || 'main' }}" |
| 34 | + |
| 35 | + - name: "Set up JDK 17" |
| 36 | + uses: actions/setup-java@v4 |
| 37 | + with: |
| 38 | + java-version: '17' |
| 39 | + distribution: 'temurin' |
| 40 | + cache: 'maven' |
| 41 | + |
| 42 | + - name: "Determine Versions" |
| 43 | + id: determine-version |
| 44 | + run: | |
| 45 | + echo "MAJOR_VERSION=$(jq -r '.version' latest.json | cut -d '.' -f 1)" >> $GITHUB_OUTPUT |
| 46 | + echo "CURRENT_VERSION=$(jq -r '.version' latest.json" >> $GITHUB_OUTPUT |
| 47 | +
|
| 48 | + - name: "Install project (skip tests)" |
| 49 | + run: mvn install -DskipTests --quiet |
| 50 | + |
| 51 | + - name: "Process sources" |
| 52 | + run: mvn process-sources -Drelease --fail-at-end --projects "${PROJECTS}" --quiet |
| 53 | + |
| 54 | + - name: "Copy delombok sources" |
| 55 | + run: find . -type d -path "*/target/delombok" -exec sh -c 'cp -r "$1"/* "$(dirname $(dirname "$1"))/src/main/java/"' _ {} \; |
| 56 | + |
| 57 | + - name: "Generate aggregated Javadoc" |
| 58 | + run: mvn clean javadoc:aggregate -Drelease -Djava.failOnWarning=false --projects "${PROJECTS}" --quiet |
| 59 | + |
| 60 | + - name: "Checkout Docs Repository" |
| 61 | + uses: actions/checkout@v4 |
| 62 | + with: |
| 63 | + repository: ${{ env.DOCS_REPO }} |
| 64 | + path: .cloud-sdk-docs |
| 65 | + token: ${{ secrets.BOT_SDK_JS_FOR_DOCS_REPO_PR }} |
| 66 | + |
| 67 | + - name: "Replace JavaDoc" |
| 68 | + id: replace-javadoc |
| 69 | + run: | |
| 70 | + TARGET_DIR=./.cloud-sdk-docs/static/java-api/v${{ steps.determine-version.outputs.MAJOR_VERSION }} |
| 71 | +
|
| 72 | + ls -lA target |
| 73 | + rm -rf $TARGET_DIR |
| 74 | + mkdir -p $TARGET_DIR |
| 75 | + mv target/reports/apidocs/* $TARGET_DIR |
| 76 | +
|
| 77 | + cd ./.cloud-sdk-docs |
| 78 | + git add -A . |
| 79 | +
|
| 80 | + CHANGED_FILES="$(git status -s)" |
| 81 | + if [[ -z "$CHANGED_FILES" ]]; then |
| 82 | + echo "[DEBUG] No changes to API docs detected, skipping Pull Request creation." |
| 83 | + echo "CREATE_PR=false" >> $GITHUB_OUTPUT |
| 84 | + exit 0 |
| 85 | + fi |
| 86 | +
|
| 87 | + echo "CREATE_PR=true" >> $GITHUB_OUTPUT |
| 88 | + BRANCH_NAME=java/release-docs-${{ steps.determine-version.outputs.CURRENT_VERSION }} |
| 89 | + echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_OUTPUT |
| 90 | +
|
| 91 | + git switch --create $BRANCH_NAME |
| 92 | + git commit -m "chore: Update JavaDocs for release ${{ steps.determine-version.outputs.CURRENT_VERSION }}" |
| 93 | + COMMIT_SHA=$(git log -1 --pretty=format:"%H") |
| 94 | + echo "COMMIT_SHA=$COMMIT_SHA" >> $GITHUB_OUTPUT |
| 95 | +
|
| 96 | + git push origin $BRANCH_NAME |
| 97 | +
|
| 98 | + - name: "Create JavaDoc PR" |
| 99 | + id: create-javadoc-pr |
| 100 | + if: ${{ steps.replace-javadoc.outputs.CREATE_PR == 'true' }} |
| 101 | + working-directory: ./.cloud-sdk-docs |
| 102 | + run: | |
| 103 | + PR_TITLE="Java: Update JavaDocs for release ${{ needs.bump-version.outputs.release-version }}" |
| 104 | + PR_BODY="Replace the contents of v${{ steps.determine-version.outputs.MAJOR_VERSION }} API docs with the latest release of the SDK." |
| 105 | +
|
| 106 | + PR_URL=$(gh pr create --title "$PR_TITLE" --body "$PR_BODY" --repo "${{ env.DOCS_REPO }}") |
| 107 | + echo "PR_URL=$PR_URL" >> $GITHUB_OUTPUT |
| 108 | + echo "PR: $PR_URL" >> $GITHUB_STEP_SUMMARY |
| 109 | + env: |
| 110 | + GH_TOKEN: ${{ secrets.BOT_SDK_JS_FOR_DOCS_REPO_PR }} |
0 commit comments