https://github.com/sunny0826/auto-docs-action

https://github.com/sunny0826/auto-docs-action

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sunny0826/auto-docs-action
• Owner: sunny0826
• License: mit
• Created: 2021-03-22T03:20:19.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-25T03:04:07.000Z (almost 4 years ago)
• Last Synced: 2024-10-31T10:41:24.116Z (2 months ago)
• Language: Shell
• Size: 14.6 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Docusaurus Auto Actions

This action that automatically process documents of Docusaurus.

## Inputs

### `gh-page`

- [**Required**] - github page repo, must be the ssh address. eg: `[email protected]:sunny0826/pod-lens.github.io.git`

### `docs-path`

- path of docs dir. default: `docs`

## Example usage

```yaml

name: docs

on:

  push:

    paths:

      - 'doc/**'

jobs:

  gh-push:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v1

      - uses: webfactory/[email protected]

        with:

          ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}

      - name: Push to GitHub Repo

        uses: sunny0826/auto-docs-action

        env:

          USE_SSH: true

          GIT_USER: git

          DEPLOYMENT_BRANCH: gh-pages

        with:

          gh-page: [email protected]:sunny0826/pod-lens.github.io.git

```