GitHub Integration for Generated Apps

Applies to: App Generation projects that use the SaaS Engine template

Connect GitHub when you need an external source repository. AppWizzy keeps its internal repository for project editing and version control.

Before you connect

You need these items:

  • a GitHub account.
  • permission to authorize the AppWizzy OAuth application.
  • active source-code access for the project.
  • an available name for the new GitHub repository.

If source access is locked, AppWizzy shows the applicable plan and credit requirements before connection.

Connect GitHub

  1. Open the generated application project.
  2. Open Code and select Push to Github.
  3. Activate source-code access when required.
  4. Sign in to GitHub.
  5. Authorize AppWizzy repository access.
  6. Enter a new repository name.
  7. Select public or private visibility.
  8. Confirm the connection.
  9. Wait for the initial source push.

You can also start the connection from Settings. AppWizzy shows the repository link after a successful connection.

Understand the branches

AppWizzy performs current development work on the ai-dev branch. Saved project versions use this branch.

The initial repository can also contain a master branch. The current stable deployment controls are unavailable.

Do not treat master as proof of a current production deployment. Check the AppWizzy deployment state separately.

Push AppWizzy changes

Use Save to create a project version after testing. Connected projects attempt to send saved changes to GitHub.

Use Code and Push to Github when the overview reports unpushed changes. This sends current internal repository content to ai-dev.

Do not keep competing histories in ai-dev. An AppWizzy push can replace divergent remote history.

Bring GitHub changes into AppWizzy

Commit external changes to ai-dev when AppWizzy must load them.

  1. Save or export important AppWizzy changes.
  2. Push the external commit to GitHub ai-dev.
  3. Open Edit via Chat.
  4. Open Version History.
  5. Select Pull Latest.
  6. Test the application.
  7. Save a new version when required.

Pull Latest discards unsaved tracked-file changes before the pull. Preserve required work first.

Use VS Code for the Web

Open Code and select Open in VSCode Web. AppWizzy opens the connected repository on github.dev.

Save and commit changes in GitHub before you use Pull Latest in AppWizzy.

Disconnect GitHub

  1. Open Settings.
  2. Find Project Code.
  3. Select Disconnect GitHub.
  4. Confirm the action.

Disconnection removes the repository link from the AppWizzy project. It does not delete the GitHub repository.

Disconnection does not revoke the AppWizzy OAuth authorization. It also does not remove the project's source-code entitlement.

Reconnect by creating another repository with an available name. Keep the old repository when you need its history.

Change the GitHub account

  1. Disconnect GitHub in the AppWizzy project.
  2. Open GitHub account settings.
  3. Open Applications and Authorized OAuth Apps.
  4. Revoke the AppWizzy authorization.
  5. Sign in to the required GitHub account.
  6. Connect GitHub from AppWizzy again.

Revoking authorization affects other AppWizzy projects that use the same stored GitHub connection.

Troubleshoot the connection

Check these items when a connection or push fails:

  • the GitHub authorization is active.
  • the repository name is available.
  • the project source repository is ready.
  • source-code access is active.
  • ai-dev does not contain conflicting external work.

Retry after you correct the reported error. Do not delete a GitHub repository as a general connection repair step.