Skip to content
This repository has been archived by the owner on Aug 31, 2024. It is now read-only.

Commit

Permalink
Merge pull request #13 from rh-robotics/milo-ghp-javadoc
Browse files Browse the repository at this point in the history
Integrate Java documentation into GitHub Pages
  • Loading branch information
IsaccBarker authored Sep 25, 2023
2 parents 11d24a9 + 90482f7 commit 98316cb
Showing 1 changed file with 25 additions and 7 deletions.
32 changes: 25 additions & 7 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,30 @@
name: Deploy Javadocs to GitHub Pages

# Keep up to date with master, not a branch.
on:
push:
branches:
- main
- milo-ghp-javadoc
branches: [master]
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

# Jobs
jobs:
# Generate the docs.
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2
Expand All @@ -27,7 +42,10 @@ jobs:
run: ./gradlew generateDebugJavadoc -PgenerateUML --no-daemon

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
uses: actions/upload-pages-artifact@v1
with:
publish_dir: ./TeamCode/build/docs/javadoc/
github_token: ${{ secrets.GITHUB_TOKEN }}
path: './TeamCode/build/docs/javadoc/'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1

0 comments on commit 98316cb

Please sign in to comment.