Skip to main content

Adding a new app

Abstract

Adding an app to Bitrise means setting up access to your repository so that you can run builds. Our project scanner determines the platform type and generates default Workflows to build and deploy your app.

Adding an app to Bitrise means granting Bitrise access to your code's Git repository so that you can run builds. During the process, we also run our project scanner that detects the platform type of your app - for example, iOS - and generate default Workflows with all the necessary Steps to build and deploy your app.

The project scanner

Supporting a platform/framework means that our project scanner can detect the type of the app and set up a basic Bitrise configuration based on the type. You can add any other app, too, regardless of how it's built but you'll have to configure it manually.

Each app is owned by a Workspace and most apps, with the exception of public apps, require some form of authentication to be able to access the repository.

To add a new app to Bitrise:

  1. On the Bitrise CI page, click the Add new app button.

    You can also open the dropdown menu next to the button to add a new app from the CLI.

  2. Select the Workspace that will own the app.

    project-access.png
  3. Set the app to private or public. This settings can't be changed later.

    • Private apps are only accessible to the Workspace members. They need to authenticate themselves to view the app's details.

    • Public apps expose their configuration file and build logs to everyone who has the link.

  4. Connect a repository. You can:

    select-repo-open.png
  5. Configure authorization to allow Bitrise to access the repository. There are multiple ways to do so, depending on the type of your app:

    • Public apps don't require authorization.

    • Private apps that are accessed via the GitHub App integration don't need additional authorization.

    • Private apps with SSH URLs, accessed via OAuth applications, require configuring an SSH key. Bitrise can do this automatically or you can create and register your own SSH key pair.

    • Private apps with HTTPS URLs, accessed via OAuth applications, require HTTPS authorization with a personal access token. We recommend using a token with only read access.

    add-ssh-key.png
  6. Set the default branch of the app and decide if you want our project scanner to scan the code on the branch.

    • If your repository is connected, you can select an available branch from a dropdown menu.

    • If you entered a repository URL manually, you need to type a valid branch name.

    Repository URL

    You will be able to change your project's repository URL later. You can also connect or disconnect your account to Git provider services at any time.

    select-branch.png
  7. Configure the app settings. You can either modify and confirm the automatically generated settings, or create a configuration manually.

    The configuration sets a stack, machine type, and a project root directory, among other things. The exact parameters to configure depends on the project type.

  8. Select an app icon. You can skip this and add an icon later.

    app-icon.png
  9. For apps with OAuth connections, add a webhook. A webhook is required to automatically trigger builds.

    Apps with the GitHub App integration don't need a webhook.

  10. Once you are done, click View App Page to go to the newly added app's home page. From there, you can start editing your Workflows and run builds.