https://github.com/tuliren/publish-gitbook

Github action to publish gitbook to github pages https://tuliren.dev/publish-gitbook
https://github.com/tuliren/publish-gitbook

deploy gitbook github-action github-page publish

Last synced: 12 days ago
JSON representation

Github action to publish gitbook to github pages https://tuliren.dev/publish-gitbook

• Host: GitHub
• URL: https://github.com/tuliren/publish-gitbook
• Owner: tuliren
• Created: 2020-01-21T05:39:38.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-19T03:23:46.000Z (over 2 years ago)
• Last Synced: 2025-01-01T06:00:17.756Z (about 1 month ago)
• Topics: deploy, gitbook, github-action, github-page, publish
• Language: Shell
• Homepage: https://github.com/marketplace/actions/publish-gitbook
• Size: 639 KB
• Stars: 18
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Gitbook Publish Action

[![Build Status](https://img.shields.io/github/workflow/status/tuliren/publish-gitbook/build?style=for-the-badge)](https://github.com/tuliren/publish-gitbook/actions/workflows/build.yml) [![GitHub Marketplace](https://img.shields.io/badge/github%20marketplace-publish%20gitbook-blue?style=for-the-badge)](https://github.com/marketplace/actions/publish-gitbook)

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

```yml

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](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line#creating-a-token)).

- Add the token as a repo secret ([instruction](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets#creating-encrypted-secrets)).

  - Secret name: `PERSONAL_TOKEN`

  - Secret value: ``