README.md

Lona GitHub Action

A Github Action to check if Lona can run on the repo and upload a documentation website to Lona.

Usage

name: Lona
on:
  push:
    branches:
      - master
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: Lona/lona-github-action@v1
        id: lona
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          workflow_succeeded: ${{ job.status == 'Success' }}
      # put some files in ${{ steps.lona.outputs.output_folder }}

Inputs

• github_token (required) - Required for permission to tag the repo. Usually ${{ secrets.GITHUB_TOKEN }}.
• workflow_succeeded (required) - Required for setting the deployment state. Usually ${{ job.status == 'Success' }}.
• lona_api_base_url - The Lona API server URL.
• output_folder - The folder that will get deployed to Lona's servers.

Outputs

• output_folder - The folder that will get deployed to Lona's servers.