SOURCE · GITHUB

Deploy from GitHub

Connect a repository, choose a revision and keep deployments traceable without placing credentials in code.

5 min readBeta documentation
Before you start
  • A GitHub repository containing a supported Node.js or Python bot
  • A package.json or requirements.txt at a predictable project root
  • A start command that works without interactive prompts

1. Connect GitHub deliberately

Open the GitHub tab, connect your GitHub account and install the Botkeep GitHub App for the repositories you choose. Private repositories require an authorised installation. Public repositories can be selected by URL.

2. Choose repository, branch and project root

  • Select the repository explicitly.
  • Choose the branch Botkeep should deploy.
  • For a monorepo, point Botkeep to the directory that contains package.json or requirements.txt.
  • Review the detected runtime and start command before the first build.

3. Keep configuration outside the repository

Store the Discord token and private connection strings as Botkeep secrets, not in committed .env files. Normal environment values can be configured separately when they are not confidential.

4. Deploy a new revision safely

Use the GitHub tab to preview and apply a repository update. Review changed files, choose whether to restart and follow progress there. Recovery options remain available if an import fails. Optional pull-on-start and push updates must be enabled explicitly. This is not a zero-downtime build-and-swap pipeline.

Repository checklist

  • No Discord token, provider token or database password in Git history.
  • Lockfile committed where the ecosystem supports one.
  • One documented start command.
  • No node_modules, virtual environment or build cache committed.
  • README notes any non-obvious runtime requirement.