Skip to content

Add latest dir for javadoc #3124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dumptruckman merged 3 commits into from
Nov 14, 2024
Merged

Add latest dir for javadoc #3124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ecca904
Add latest dir for javadoc
benwoo1110 Nov 14, 2024
99a716c
latest boolean
benwoo1110 Nov 14, 2024
41cab5b
Improve replace_latest description
benwoo1110 Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions .github/workflows/dispatch.javadoc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ on:
target_tag:
description: 'Version to generate javadoc'
required: true
replace_latest:
description: 'Replace the latest folder'
type: boolean

jobs:
javadocs:
Expand All @@ -28,12 +31,24 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_VERSION: ${{ inputs.target_tag }}


- name: Copy javadoc to deploy folder
run: |
mkdir -p build/docs/javadoc-deploy/${{ inputs.target_tag }}
cp -r build/docs/javadoc/* build/docs/javadoc-deploy/${{ inputs.target_tag }}

- name: Copy javadoc to latest folder
if: inputs.replace_latest
run: |
mkdir -p build/docs/javadoc-deploy/latest
cp -r build/docs/javadoc/* build/docs/javadoc-deploy/latest

- name: Deploy javadoc to gh pages
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
folder: build/docs/javadoc
folder: build/docs/javadoc-deploy
branch: javadoc
target-folder: javadoc/${{ inputs.target_tag }}
target-folder: javadoc
clean: false
commit-message: Deploy javadoc for ${{ inputs.target_tag }}
13 changes: 11 additions & 2 deletions .github/workflows/generic.github_release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,21 @@ jobs:
GITHUB_VERSION: ${{ steps.release.outputs.publish_version }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Copy javadoc to version and latest folder
if: steps.javadoc.outcome == 'success'
run: |
mkdir -p build/docs/javadoc-deploy/latest
mkdir -p build/docs/javadoc-deploy/${{ steps.release.outputs.tag_name }}
cp -r build/docs/javadoc/* build/docs/javadoc-deploy/latest
cp -r build/docs/javadoc/* build/docs/javadoc-deploy${{ steps.release.outputs.tag_name }}

- name: Deploy javadoc to gh pages
if: steps.javadoc.outcome == 'success'
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
folder: build/docs/javadoc
folder: build/docs/javadoc-deploy
branch: javadoc
target-folder: javadoc/${{ steps.release.outputs.tag_name }}
target-folder: javadoc
clean: false
commit-message: Deploy javadoc for ${{ steps.release.outputs.tag_name }}
Loading