Skip to content

chore(deps): update actions/cache action to v6 (#74) #183

chore(deps): update actions/cache action to v6 (#74)

chore(deps): update actions/cache action to v6 (#74) #183

Workflow file for this run

# .github/workflows/docs.yml
#
# Builds aggregated Dokka HTML documentation and deploys to GitHub Pages on
# every push to main. The site is also built (but not deployed) on pull
# requests so documentation regressions are caught before merge.
#
# URL after deployment: https://meshtastic.github.io/meshtastic-sdk/
name: Documentation
on:
push:
branches: [main]
pull_request:
branches: [main]
permissions:
contents: read
pages: write
id-token: write
# Only one deployment runs at a time; in-progress deploys are NOT cancelled so
# a concurrent push to main doesn't leave the site in a half-updated state.
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
name: Build Dokka docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
submodules: recursive
- name: Set up JDK 21
uses: actions/setup-java@03ad4de0992f5dab5e18fcb136590ce7c4a0ac95 # v5.6.0
with:
java-version: "21"
distribution: temurin
- name: Set up Gradle
uses: gradle/actions/setup-gradle@3f131e8634966bd73d06cc69884922b02e6faf92 # v6.2.0
- name: Build aggregated documentation
run: ./gradlew :dokkaGenerate --no-daemon
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: build/dokka/html
deploy:
name: Deploy to GitHub Pages
needs: build
# Deploy only on pushes to main, not on pull requests.
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0