onejar99 / gitbook-build-publish-action

A GitHub Action to build and publish GitBook.

GitHub Action for Gitbook Build and Publish

Introduction

The GitHub Action is used to build GitBook static site files and deploy to GitHub Pages via gh-pages branch.

How to Use

It's very easy to use it. Add a workflow like shown:

name: Build and Publish My GitBook

on:
  workflow_dispatch:
  push:
    branches:
      - master

jobs:
  build-and-deploy:
    name: Build and deploy
    runs-on: ubuntu-latest
    env:
      MY_SECRET   : ${{secrets.GH_ACCESS_TOKEN}}
      USER_NAME   : <Your Git username>
      USER_EMAIL  : <Your Git email>
      BOOK_DIR    : your_book_sources_folder_name

    steps:
    - name: Checkout 🛎️
      uses: actions/[email protected]

    - name: Build and Deploy 🚀
      uses: onejar99/[email protected]

gitbook-build-publish-action's Issues

feat: support cname

refer to onejar99/demo-build-and-publish-gitbook#1

fix: plugin anchor-navigation-ex dependency issue with [email protected]

[situation]
user ticket: onejar99/demo-build-and-publish-gitbook#2

When gitbook build, loading plugin anchor-navigation-ex will cause a weird crash and stick the process.
Reviewed dependency tree and discovered the [email protected] is the root cause. [email protected] was fine.

error:

root@659a36a58fc5:/gitbook# gitbook install
info: installing 5 plugins using [email protected]
info:
info: installing plugin "anchor-navigation-ex"
info: install plugin "anchor-navigation-ex" (*) from NPM with version 1.0.14
/gitbook
`-- [email protected]
  +-- [email protected]
  | +-- [email protected]
  | | +-- [email protected]
  | | +-- [email protected]
  | | +-- [email protected]
  | | `-- [email protected]
  | +-- [email protected]
  | | `-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | | +-- [email protected]
  | | +-- [email protected]
  | | `-- [email protected]
  | |   +-- [email protected]
  | |   | `-- [email protected]
  | |   `-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | +-- [email protected]
  | `-- [email protected]
  +-- [email protected]
  `-- [email protected]

info: >> plugin "anchor-navigation-ex" installed with success
info:
info: installing plugin "edit-link"
runTopLevelLifecycles ->  / |##############################################################################################---|
/gitbook
+-- [email protected]
`-- [email protected]

info: >> plugin "edit-link" installed with success
info:
info: installing plugin "copy-code-button"
runTopLevelLifecycles ->  \ |##############################################################################################---|
/gitbook
+-- [email protected]
+-- [email protected]
`-- [email protected]

info: >> plugin "copy-code-button" installed with success
info:
info: installing plugin "theme-comscore"
runTopLevelLifecycles ->  \ |##############################################################################################---|
/gitbook
+-- [email protected]
+-- [email protected]
+-- [email protected]
`-- [email protected]

info: >> plugin "theme-comscore" installed with success
info:
info: installing plugin "ga"
runTopLevelLifecycles ->  / |##############################################################################################---|
/gitbook
+-- [email protected]
+-- [email protected]
+-- [email protected]
+-- [email protected]
`-- [email protected]

info: >> plugin "ga" installed with success
root@659a36a58fc5:/gitbook# gitbook build
info: 12 plugins are installed
info: 11 explicitly listed
info: loading plugin "anchor-navigation-ex"... LIBERTY LIBERTY LIBERTY
LIBERTY LIBERTY LIBERTY
LIBERTY LIBERTY LIBERTY
                                   !             H|H|H|H|H           H__________________________________             H|§|§|§|H           H|* * * * * *|---------------------|             H|§|∞|§|H           H| * * * * * |---------------------|             H|§|§|§|H           H|* * * * * *|---------------------|             H|H|H|H|H           H| * * * * * |---------------------|             H|H|H|H|H           H|---------------------------------|          ===============        H|---------------------------------|            /| _   _ |          H|---------------------------------|            (| O   O |)          H|---------------------------------|            /|   U   |          H-----------------------------------             |  =/  |           H              _..._/            H              _|I/|_            H      _______/| H |/_______    H     /           / /          H    |          | | /         |  H    |          ||o||          |  H    |    |     ||o||     |    |  H    |    |     ||o||     |    |  H   Carl Pilcher
t̛͌̐̍̅ͣ͆̿͊̌͠ ҉͎̟͍̠̤͍̜͇̳̼̳̤̜̟̙̯̻̝ę̛͙͓͎̘̯̳̯̘̳͊̒̓̽̃̌͜͝s̴̡̳̞͚̹̃͒ͣ͂̏ͩͨͨͥ̒t̷̐̎̆̑ͬ̇̄̓̈̄̿ͩ̄̂̐̃͂̌ȋ̡̟̫̳͓͉̟̇ͨͣͮ̑̾̎̔̚̚͞n̴̨̧̠̭͕̉̾ͮͮͫ̓ͮ̑̈̂̾͜͡g̶̢̘̫̥̪̰̝̠͓̥̮ͯ͒̏͂͘͟ͅ ̷̵̼̻͍͉̜̘͖͓̓̒̇̍ͤͧ̈͜͞t̷̵̵͚̻͍̠̺̹̗̥̼̓͌ͮ͐͑̌ͅe̢͖̼͉͔̞̰͚̤͗ͬ̐̃ͫ͆͂̎̓̕s̶̪̖͙̱̬͖̖̒ͤ̽̽ͭ̑̆ͥ̀ͅͅt͌ͭͥ͌̑ͭͨ͋ͦ̃ͮͯ̊̀ͤ̈ͣ͊́ĭ̧̥͋͐͊̈͛ͯ̌̇̀̿̆̓̂̉̉̀n̶̡͈͉͕͉̟ͫͬͥ̂̀ͩ̿̉̾́́͢g̴̡̛̯͕̺̫̿̀ͫ͒ͩ͗ͫ̏̃ͧͪ́ ̵̢̝̦͕̯̗̠̗̩͖͎͐͂̂̀̋͛͊t̶̸̢̻̟̱̪̪͍̔̐̌́ͦ̃̌͑̾͜e̵̷̓̓ͭͥ̄ͨ͒̋̓ͪ̈̔͊̊́̈̕ṡ̓ͮ͌̆ͭ̅̀̀ͯ̔̓̎ͩͯͣ̆̽ͬţ̸̨̛͕̲̙̲̒̈͊ͯ̏̊͊ͭ͋͌̾i̡͉̬̹̞ͪ̑̈ͧ͒ͩ̈̒ͮ̌͗̄́͘nͧ̓̄̿͛̊ͧ̓͒͛̽̄ͦ̋ͯ̔̏͑͛gͣ̑ͥ̎̇̇̓̌̐̿ͣͪͫ͛ͨ͊̂ͬ̚ ̵̸̶̧ͮ̓̔̋͛͐̑ͦ̀̔̿̌ͨ ҉̫̖̟͉͍̦̳̩͖̫̥̲̩̭̤͉̖ͅt͎̣͔͓͇̤̩̫̘ͥ̉̌ͬ͂̈ͫ̀̚͘ȩ̢̛͕̣̣̦͚̬͎͆͒̈ͥͥͨͭ͂ͯs̙͇̺̯̈ͧ́ͦ́ͬ̐ͦ͂̆ͬ͂̈͘͟t̵̴̮̮͉͇̣̉ͤ̔ͥ̇̾̒̿̈̋̚ͅi̴͚͚̲̝̥̹̞̤̩̻͖ͣ̑͋̈ͣ͡ͅn̽̿ͦ̄́̆ͣ̈͐ͭͪ̊ͪ ҉̴̸͢ ҉͚͙͈̜̳̘̟̥̬̞̰̻̟̬̜͓̝͙ģ̷̢̜͙̞̖͖̤̗̯̖͕̈̃̈ͮ͘͢ ̨̬̼̬̣̋̐̒̈ͮ͗̉̓̋ͥ̏̃͑͘t̤͖̼͍̙̣̲̯̦̿̿̈̉͆͊̓́͘͝ȅ̵̢̢̡͎̱̻̈͌͐̑͌̋̎̆̔ͪ͛s̠͇̳̹̙̭͂͗̏̈̀ͥͦ̂ͥ̚̚͠͞t̴̛̬̫̥͕͇̲̥̍̇̂̂̔̂̐́͘͞i̽ͦ̎ͤͫͥ̽́̊͛̓̌ ҉͙͓͚͎̙̰̥̼̰͍̤͔̼͈̫̦̀ͅn̡̨̞͙̟͖͙͓̞̩̅ͯ͆ͨͬͥ͢͝͡g̢̢̊͌͆͆ͨ̅͛͜ ҉̙͖̤͚̗̯̬͓̩̣̺͍̺͉̰̜̖̙ ̸̨̜̣͖̿͐͒͗̊͒ͥ͑̅̏ͫ͗͢͡ẗ̡͂͑̋̂̂̌͂ͫ̀ͯ̃ͣͦ͗̎̌́ē̠ͭ͆̓̇͆̎̇̎͗̂̆ͣ̄̇̄͘͝s̴̢̩̼͎̭̹͚͒̑ͭͨ̑̿̈ͪ͢͡ͅt̨̟̮̖̲̳̰̯̑̒̑͌̊ͧ̈́̕͝ͅi̸ͨ̑̽̅́̏̇̎͒̒̃͂ͫͦ͌͝͞͡ņ̛̯̠̓͒̅̈ͫ̽ͣͮͤ̆̃̔̄̔͘g̶̶̡͚͙̱͉̾̏̏͗ͪͮ͌̿̈̋̀ͅ ̴̘͉ͨͣͬ̋̂̓̿̑ͦ͋̏ͪ͐̒́͜t̴̢ͥ͒͑͂͒͛͂ͭͥ̃͋ͮͭ̏͑̓͢e̠̳̟̣̝̰̼̹̲̜̰͍͕̽̔̿͊͜͠s̢̝̩̗̭̗̩̦̯̟̝ͩ̾̐̆͌̈́͢t̸̴̲͕̱̦͚͎̠̬ͩ͐̏̍ͣ̾̂̂͆ĭ̵̻̹͈̫͎͍̩̗̠̹̰̋ͦ̆͠ͅͅn̴̡̡͎͕͎̤̣̠̯̘ͤ͂ͦ̉͆ͪ̅ͣģͭ̏̔́̌̽̇̾̿ ҉̷̝̥̖̙̬̳̗̺͕̪̯̗͘Arraẏ̡̛̗̱̼͕̤ͮ̈ͦ͛͗͗ͪ͌ͮ̽ͧfunction(symbol) {
      var $a, self = this, $iter = TMP_5.$$p, block = $iter || nil, $splat_index = nil;

      var array_size = arguments.length - 1;
      if(array_size < 0) array_size = 0;
      var args = new Array(array_size);
      for($splat_index = 0; $splat_index < array_size; $splat_index++) {
        args[$splat_index] = arguments[$splat_index + 1];
      }
      TMP_5.$$p = null;
      return $scope.get('Kernel').$raise($scope.get('NoMethodError').$new((function() {if ((($a = self.$inspect && !self.$inspect.$$stub) !== nil && (!$a.$$is_boolean || $a == true))) {
        return "undefined method `" + (symbol) + "' for " + (self.$inspect()) + ":" + (self.$$class)
        } else {
        return "undefined method `" + (symbol) + "' for " + (self.$$class)
      }; return nil; })(), symbol));
    }̢͙̟̦͖͌̇̐͂̇ͣ͊ͪ͛̇̌͟͢͝function() {

exec /entrypoint.sh: no such file or directory

Hi,

最近執行都會出現下面錯誤而無法正常build and deploy
請問是設定問題嗎?

exec /entrypoint.sh: no such file or directory

Dependency installation failure

Looks like the github-issue-feedback plug-in installation fails during GH action execution. See log in sysprog21/cpumemory-zhtw, screenshot below. Perhaps this is fixable with same workaround in issue #3?

$MY_SECRET will be printed

I am just wondering if this is a security hazard to print $MY_SECRET - which could be a user's access GH token.

https://github.com/onejar99/gitbook-build-publish-action/blob/master/entrypoint.sh#L20