Framework Cloud docs

GitHub integration

GitHub integration lets you sign in with GitHub and create projects as GitHub repositories. It is free on Framework Public Cloud. On your own server, an admin sets it up first (see Server setup).

Account connection

  1. Open Account > GitHub and connect your GitHub account. If you signed up with GitHub, it is already connected.
  2. Install the Framework app on your GitHub account and on any organization where you want new repositories. GitHub asks which repositories the app may reach. The app can only work in repositories it creates or that you give it.

GitHub projects

  1. Open Projects > New project and choose a blueprint.
  2. Under Delivery method, choose On GitHub.
  3. Pick the account or organization, name the repository, and choose whether it is private. Blueprints for restricted data require a private repository.
  4. Click Create on GitHub.

Framework Cloud creates the repository, and a one-time GitHub Action builds the project files in it. The action runs the framework R package for R projects and fw for Stata projects. The project page shows when it is done. Then clone the repository and start working:

git clone https://github.com/you/your-project.git

Disconnection

Account > GitHub > Disconnect removes the connection. Your repositories stay on GitHub. To remove the app's access completely, uninstall it in your GitHub settings under Applications.

Edit this page on GitHub