Signing up to Codemagic
You can sign up to Codemagic using a GitHub, Bitbucket or GitLab account or a regular email address. After signup, you can add apps from any self-hosted or cloud-based Git repository, see Adding repositories.
Sign up via GitHub
Codemagic offers two types of integration with GitHub.
Select All repositories to sign up via OAuth. This integration requires read/write access to your repositories and is the preferred integration method if you’re looking to publish GitHub releases or push tags to the repository.
Select Selected repositories only to sign up using Codemagic GitHub app. This integration requires read access to your code and you can grant access to selected repositories only. Note that you will also need to install the Codemagic CI/CD GitHub app to share repositories. This is the preferred integration method if you want to use GitHub Checks. Read more about the integration here.
All repositories (OAuth)
When authenticating via OAuth, Codemagic asks for read/write permission to access your GitHub repositories and create webhooks for automatic building. Write permission is also required for pushing tags to the repository.
You will need to authorize Codemagic to connect the GitHub account to your Codemagic account. Once you log in to Codemagic, you will see all your GitHub repositories listed.
Can’t see your GitHub organization repositories?
Organizations can restrict access to third-party OAuth applications. As a member, you can request that organization admins authorize the application for use in that organization.
- In your GitHub settings, navigate to Organization settings > Third-party access.
- If you don’t see Codemagic listed there, go to Personal settings > Applications > Authorized OAuth Apps.
- Click on the Codemagic app.
- Under Organization access, click Request access > Request approval from owners.
Read more about GitHub organizations and OAuth app restrictions.
Selected repositories (GitHub app)
With the GitHub app integration, you have more control over the repositories you share with Codemagic, and instead of write access, only read access to your code is required.
- Click GitHub at codemagic.io/signup and select Selected repositories only to sign up via Codemagic GitHub app.
- Click Authorize Codemagic to verify your identity. You will be authenticated via GitHub without granting access to any of your repositories.
- In Codemagic, click Install GitHub App on the Applications page. If you already have another repository integration enabled for your personal account, you can find the installation button in User settings > Integrations > Install GitHub App.
- Click Finish installation and then Install app. You will be then redirected to GitHub to proceed with installation.
- Next, select the GitHub account or organization where you want to install the app.
- Select whether to grant access to All repositories or select the repositories to share by choosing Only select repositories.
- Click Install & Authorize (you may be asked to confirm that action by entering your password). After successful installation, you will be redirected back to Codemagic and you can see the status for the GitHub app integration as connected. If you do not have the permission to install the app under an organization, you will see the button Authorize & Request instead. An approval from the organization owner or app manager is needed to authorize the installation of the app.
Configuring accounts and repositories
If you want to install Codemagic GitHub app to another GitHub account/organization or change repository access settings, e.g. add new repositories, navigate to the integrations section and click Manage integration > Configure. Then select an account to configure. Make the necessary changes and click Save.
You can access the same settings in GitHub by navigating to GitHub > Settings > Applications > Installed GitHub Apps > Codemagic CI/CD or going directly to https://github.com/apps/codemagic-ci-cd and clicking Configure. Note that the settings you configure in Codemagic CI/CD GitHub app prevail over the GitHub OAuth integration settings.
If you revoke access to previously shared repositories, you will still see all your apps and build history but won’t be able to build the apps to which Codemagic no longer has access. Such apps will be grayed out and will show up on the Applications page with the Removed from repository filter.
The repository access settings configured in Codemagic GitHub app apply to the repositories you share in your Codemagic team only if:
- GitHub App integration is connected in Team settings > Team integrations.
- The primary team owner has connected the GitHub App integration for their personal account in User settings > Integrations and the team has not enabled the GitHub (OAuth) integration. If the regular GitHub integration is enabled for the team, the connected account makes use of OAuth permissions and the restrictions you configure in GitHub App do not apply.
Diconnecting Codemagic GitHub app integration
The Codemagic CI/CD GitHub App integration can be disabled by clicking Manage integration > Disconnect in User settings > Integrations > GitHub App for your personal account or in Team settings > Team Integrations > GitHub App to disconnect it from the team. This annuls all settings configured for the Codemagic app in GitHub but won’t delete your buid history.
The GitHub app integration is also disabled when you uninstall the Codemagic CI/CD app in GitHub. You can still log in to Codemagic with the GitHub app and see your build history if Codemagic CI/CD remains an authorized GitHub app in GitHub. Please note that unless you have other active integrations (e.g. GitHub, Bitbucket or GitLab OAuth integration), your Codemagic account will be deleted in two weeks. You can cancel account deletion by navigating to User settings > Delete account and clicking Cancel deletion before the two weeks are up.
Sign up via Bitbucket or GitLab
When authenticating using a Bitbucket or GitLab account via OAuth, Codemagic asks for read/write permission to access your repositories and create webhooks for automatic building. Write permission is also required for pushing tags to the repository.
You will need to authorize Codemagic to connect the Bitbucket/GitLab account to your Codemagic account. Once you log in to Codemagic, you will see all your repositories listed.
Sign up via email
Enter your email address and name and click Create account to get started. Codemagic will then send a six-character authentication key on the provided email address. Enter the authentication key and click Continue to verify the email address and finish signup. Note that an unused key expires in 10 minutes.
You will be sent a new authentication key every time you need to log in again.
Connecting several repository integrations
You can connect several repository accounts (GitHub, GitHub app, GitLab, Bitbucket) with one Codemagic account or Codemagic team (read more about managing team integrations here).
- Log in to Codemagic with the account you signed up.
- Click on your account avatar at the bottom left and open User settings.
- In the Integrations section, click Connect next to the account you would like to connect to Codemagic.
Once you have connected another account to your Codemagic account, you can log in to Codemagic with either of these accounts. Email notifications with build status reports will be sent to the email address that’s connected with the repository from which you build.