Bitrise is powerful and complex - but getting started is easy and intuitive! You can kick off your first build within minutes of signing up. Let’s go over what you need to do make that happen!
Signing up to Bitrise ⚓
First of all, you need a Bitrise account. Choose one of the following to sign up:
Signing up with either of the Git service providers means you connect your Bitrise account to your account on that service provider. With a connected account, you can easily grant Bitrise access to any of your repositories on that account.
After signing up, you can connect your Bitrise account to all of the three supported Git service providers. For example, after you signed up with GitHub, you can connect your Bitrise account to both your GitLab and Bitbucket accounts, too, and access any repositories you have on those accounts.
Adding apps ⚓
Add a new app any time by clicking the
+ symbol on the top menu bar and then selecting
Add app from the dropdown menu.
Set your app’s privacy setting to either private or public:
- Private apps can be accessed only by you, your organization members and team members.
- Public apps expose their build logs and their
bitrise.ymlfile to everyone.
Connecting a repository ⚓
Tell Bitrise where the code of your app is stored. You can either:
- Connect a repository from a connected GitHub/GitLab/Bitbucket account. Bitrise will then automatically display all the available repositories from the selected service, all you need to do is choose one.
- Manually add the location of the source code: choose the
Other/Manualoption then paste an HTTPS git clone URL.
- You can also use a repository that is on a self-hosted GitLab instance.
Why does Bitrise need write permissions on Github/Bitbucket/GitLab? Connecting your GitHub/GitLab/Bitbucket account gives Bitrise write permission to the repositories. There are two things that Bitrise couldn’t do without it:
- Adding an SSH key to the selected repository
- Registering a Webhook for the repository
Setting up repository access ⚓
Set up an SSH key to access the selected repository. This is required for private apps to ensure Bitrise can clone the repository. You can:
- auto-add the SSH key Bitrise generated.
- copy the public key Bitrise generated.
- use your own SSH keypair. Make sure your private key is an RSA key without a passphrase.
Public apps cannot have SSH keys.
Validating and configuring the project ⚓
After setting up repository access, type the branch of the repository you wish to use and click
Bitrise will scan and validate your repository and set up a project configuration based on the results. If the validation fails, you can set up the project manually.
Webhook setup ⚓
Register a webhook immediately so Bitrise can start a build every time you push code into your repository. You can skip webhook setup when creating a new app: you can always set up webhooks later.
Builds and workflows ⚓
Once you added an app, your first build will be kicked off automatically. This means running a workflow which is a collection of Steps. Steps represent a block of script execution with predefined input and output variables and they are the heart of Bitrise. You can create new workflows, chain workflows together. You can also modify Step inputs, add and remove Steps to and from workflows.
Teams and organizations ⚓
Once you set up a new app, you can start inviting team members. If you have a Developer or an Organization plan, you can have unlimited team members!
You can also create organizations if you are on one of our Organization plans. Organizations allow you to manage entire teams quickly and effectively.
The project scanner is a tool that identifies the given project's type and generates a basic Bitrise configuration. Each supported project type has its own scanner: these scanners are stored...
Both incoming and outgoing webhooks can be set up with the Bitrise API. They are important for automatic build triggering and the reporting of build events to other services.
Trigger builds manually or by setting up automatic triggers. Learn about the different trigger types, as well as about manually starting a new build.