spring-doc-actions's Introduction

spring-doc-actions

A set of GitHub actions for Spring documentation.

bust-cloudflare-antora-cache

A GitHub action that busts the Cloudflare Cache for Spring based Antora docs.

inputs:
  context-root:
    description: The context root of the documentation (e.g. for https://docs.spring.io/spring-security/reference/ context-root is spring-security)
    required: true
  cloudflare-zone-id:
    description: The cloudflare zone id
    required: true
  cloudflare-cache-token:
    description: The cloudflare cache token
    required: true

Example usage:

github/workflows/deploy-docs.yml

    - name: Bust Clouflare Cache
      uses: spring-io/spring-doc-actions/[email protected]
      with:
        context-root: spring-security
        cloudflare-zone-id: ${{ secrets.CLOUDFLARE_ZONE_ID }}
        cloudflare-cache-token: ${{ secrets.CLOUDFLARE_CACHE_TOKEN }}

rsync-antora-reference

A GitHub action that syncs Antora reference documentation using rsync with support for syncing a single version. It deploys to the docs server using the GitHub repository in the path.

inputs:
  docs-username:
    description: The username to connect to the docs server
    required: true
  docs-host:
    description: The host of the docs server
    required: true
  docs-ssh-key:
    description: The ssh key used to connect to the docs-host
    required: true
  docs-ssh-host-key:
    description: The docs ssh host key used to connect to docs-host
    required: true
  dry-run:
    description: Set to false if should perform the sync, else a dry run is performed
    default: false
    required: false
  site-path:
    description: The path to the site that should be synced
    default: build/site
    required: false

Example usage:

github/workflows/deploy-docs.yml

    - name: Publish Docs
      uses: spring-io/spring-doc-actions/[email protected]
      with:
        docs-username: ${{ secrets.DOCS_USERNAME }}
        docs-host: ${{ secrets.DOCS_HOST }}
        docs-ssh-key: ${{ secrets.DOCS_SSH_KEY }}
        docs-ssh-host-key: ${{ secrets.DOCS_SSH_HOST_KEY }}
        dry-run: true

Recommend Projects