Skip to content

Latest commit

 

History

History
 
 

github

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
assets
assets
 
 
src
src
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
gitbook-manifest.yaml
gitbook-manifest.yaml
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

Publishing this Integration

Prerequisites

  1. Make sure you've setup this repository and authenticated with the gitbook CLI properly.
  2. Once that is done, ensure that you have a GitHub App configured and published correctly.

Publishing

Go to the integration folder at cd integrations/github. Before you run publish you must set a bunch of environment variables that are defined in the manifest file. In order to do that, open your GitHub App settings at https://github.com/settings/apps and then do the following

  • export GITHUB_APP_INSTALL_URL=https://github.com/apps/your-app-name/installations/new , and replace your-app-name with whatever is the name of your app currently in the settings page URL.
  • export GITHUB_APP_ID=app-id-from-settings
  • export GITHUB_CLIENT_ID=client-id-from-settings
  • export GITHUB_CLIENT_SECRET=client-secret-that-you-noted-down-earlier
  • export GITHUB_WEBHOOK_SECRET=webhook-secret-that-you-noted-down-earlier
  • export GITHUB_PRIVATE_KEY=`cat ~/Downloads/gitbook-dev-YOURNAME.key`

(this is the file that we converted from .pem to .key earlier. Make sure the file exists at the path)

Once you've exported these env variables, it's time to run the publish script:

gitbook publish --organization orgId where orgId will be the ID of your personal organization in your dev environment under which this integration should be published.

Important

Make sure to verify the published integration by storing verified: true on the integration object in the DB.