The content of this page is no longer updated as of July 2017. Visit https://docs.sideci.com for up to date documentation.

GitHub Integration

Last Updated November 22, 2015

This is a document related to GitHub Integration.
The contents are as follows.

  • GitHub integration settings (Authorized applications)
  • Adding repositories (Webhook / PullRequest Comment)
  • Disabling the GitHub integration
  • Trouble shooting

GitHub integration settings

After signing up in SideCI, the SideCI will be added to the Authorized applications in the logged GitHub user account.

Adding repositories

After adding a repository in SideCI, the SideCI's URL will be added into the Webhooks under Webhooks & Services of that repository.
Moreover, events likepull_request orpush will be sent to the SideCI from GitHub.

When creating or updating the PullRequest, if the function which comments the result from the analytical tool into the pull request, a new comment will be created in the Pull Request when a new notification is available.

Disabling the GitHub Integration

You can disable the integration between SideCI and GitHub with the following 2 operations.
1. Disabling the repository in SideCI (Remove Webhook)
2. Revoking GitHub authorization in SideCI

Moreover, since SideCI doesn’t get or save the source code, by executing above operations SideCI won’t be able to access to the source code.

Disabling the repository in SideCI(Remove Webhook)

You can disable the repository via the Disable button on the left menu of the screen after login in SideCI.

This operation will delete the SideCI URL from target repository's Webhooks. Moreover, then you will no longer be able to view the repository information from the screen after login in SideCI.

SideCI will not be able to perform analysis even if you create a PullRequest.

Revoking GitHub authorization in SideCI

Since removal of the access rights for GitHub cannot be done on the SideCI's side, kindly perform the following operations in GitHub.

  1. Access to GitHub
  2. Open the user's Settings page
  3. Find SideCI from Applications > Authorized Applications and hit Revoke

When this operation is taking place, it is not possible to access to the target repository, user's all information and the source codes.

** [Note] **

  • Kindly perform this operation after disabling the repository in SideCI. Otherwise, Webhook will continue to run and GitHub will mail to SideCI. Sine all rights have been revoked from SideCI, it is not possible to delete the registration of Webhook.
  • To fully remove the access rights in the repository, perform this operation by all the users who is sign up via SideCI
  • After performing this operation, the SideCI will be added to Authorized applications when you sign up again.

Troubleshooting

You can receive communications from the chatbox on the lower right of the screen.

Please kindly contact us via the chatbox under the lower right side of the screen in case you encounter any issues.

Although there are cases that the issue will be solved by signing up again after executing the above, your contact to us will be appreciated.

GitHub Integration

Last Updated November 22, 2015

This is a document related to GitHub Integration.
The contents are as follows.

  • GitHub integration settings (Authorized applications)
  • Adding repositories (Webhook / PullRequest Comment)
  • Disabling the GitHub integration
  • Trouble shooting

GitHub integration settings

After signing up in SideCI, the SideCI will be added to the Authorized applications in the logged GitHub user account.

Adding repositories

After adding a repository in SideCI, the SideCI's URL will be added into the Webhooks under Webhooks & Services of that repository.
Moreover, events likepull_request orpush will be sent to the SideCI from GitHub.

When creating or updating the PullRequest, if the function which comments the result from the analytical tool into the pull request, a new comment will be created in the Pull Request when a new notification is available.

Disabling the GitHub Integration

You can disable the integration between SideCI and GitHub with the following 2 operations.
1. Disabling the repository in SideCI (Remove Webhook)
2. Revoking GitHub authorization in SideCI

Moreover, since SideCI doesn’t get or save the source code, by executing above operations SideCI won’t be able to access to the source code.

Disabling the repository in SideCI(Remove Webhook)

You can disable the repository via the Disable button on the left menu of the screen after login in SideCI.

This operation will delete the SideCI URL from target repository's Webhooks. Moreover, then you will no longer be able to view the repository information from the screen after login in SideCI.

SideCI will not be able to perform analysis even if you create a PullRequest.

Revoking GitHub authorization in SideCI

Since removal of the access rights for GitHub cannot be done on the SideCI's side, kindly perform the following operations in GitHub.

  1. Access to GitHub
  2. Open the user's Settings page
  3. Find SideCI from Applications > Authorized Applications and hit Revoke

When this operation is taking place, it is not possible to access to the target repository, user's all information and the source codes.

** [Note] **

  • Kindly perform this operation after disabling the repository in SideCI. Otherwise, Webhook will continue to run and GitHub will mail to SideCI. Sine all rights have been revoked from SideCI, it is not possible to delete the registration of Webhook.
  • To fully remove the access rights in the repository, perform this operation by all the users who is sign up via SideCI
  • After performing this operation, the SideCI will be added to Authorized applications when you sign up again.

Troubleshooting

You can receive communications from the chatbox on the lower right of the screen.

Please kindly contact us via the chatbox under the lower right side of the screen in case you encounter any issues.

Although there are cases that the issue will be solved by signing up again after executing the above, your contact to us will be appreciated.