Skip to content
book

GitHub Action

Publish Gitbook

v1.0.1 Latest version

Publish Gitbook

book

Publish Gitbook

Publish Gitbook to GitHub Pages

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Publish Gitbook

uses: tuliren/[email protected]

Learn more about this action in tuliren/publish-gitbook

Choose a version

Gitbook Publish Action

Build Status GitHub Marketplace

This action publishes a gitbook to github pages.

The source branch is master, and the target branch is gh-pages. If gh-pages does not exist, it will be created automatically.

How to Use

jobs:
  build:
    name: Build Gitbook
    runs-on: ubuntu-latest
    steps:
      # Check out the repo first
      - name: Checkout code
        uses: actions/checkout@v2
      # Run this action to publish gitbook
      - name: Publish
        uses: tuliren/[email protected]
        with:
          # specify either github_token or personal_token
          github_token: ${{ secrets.GITHUB_TOKEN }}
          # personal_token: ${{ secrets.PERSONAL_TOKEN }}

Please note that either personal_token or github_token needs to be specified.

github_token (recommended)

If you choose github_token, this token is auto created when workflow launches. No extra operation is needed.

personal_token

  • Create a Personal Access Token (instruction).
  • Add the token as a repo secret (instruction).
    • Secret name: PERSONAL_TOKEN
    • Secret value: <token>