Generate specification documentation #4
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This workflow automates the creation of Specification Documents | |
| # which will be copied into https://github.com/jakartaee/specifications | |
| name: Generate specification documentation | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| specVersion: | |
| description: 'Major and Minor level of release. Example: 1.0' | |
| required: true | |
| jobs: | |
| generate: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0 | |
| - name: Set up JDK 17 | |
| uses: actions/setup-java@b36c23c0d998641eff861008f374ee103c25ac73 # v4.4.0 | |
| with: | |
| java-version: 17 | |
| distribution: 'temurin' | |
| cache: maven | |
| - name: Generate specification docs | |
| run: | | |
| mvn package --file api/pom.xml -Dspec.version=${{ github.event.inputs.specVersion }} | |
| mvn package --file spec/pom.xml -Drevremark=FINAL -Dspec.version=${{ github.event.inputs.specVersion }} | |
| - name: Assemble documentation | |
| run: | | |
| mkdir documentation/ | |
| cp spec/target/generated-docs/jakarta-data-${{ github.event.inputs.specVersion }}.pdf documentation/jakarta-data-${{ github.event.inputs.specVersion }}.pdf | |
| cp spec/target/generated-docs/jakarta-method-name-query-${{ github.event.inputs.specVersion }}.pdf documentation/jakarta-method-name-query-${{ github.event.inputs.specVersion }}.pdf | |
| cp spec/target/generated-docs/jakarta-data-${{ github.event.inputs.specVersion }}.html documentation/jakarta-data-${{ github.event.inputs.specVersion }}.html | |
| cp spec/target/generated-docs/jakarta-method-name-query-${{ github.event.inputs.specVersion }}.html documentation/jakarta-method-name-query-${{ github.event.inputs.specVersion }}.html | |
| cp -r api/target/apidocs/ documentation/apidocs | |
| - name: Upload documentation | |
| uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0 | |
| with: | |
| name: Specification Documentation | |
| path: documentation/ | |
| if-no-files-found: error |