Connect with JIRA

How to connect to JIRA

JIRA is enterprise software provided by Atlassian used for bug tracking, issue management, and project management.By connecting Sleeek and JIRA with API token, you can collect and visualize the progress status of issues and projects managed by JIRA and member comments linked to them.
By connecting JIRA to Sleeek to which Repository management system has already been connected, it is possible to comprehensively grasp the information of all elements that make up a project such as Code, Issue and Member, and prepare in advance for future project risks. Become.

Setup Procedure

1. Login to Sleeek, then go to the “Settings” page.You can view the registered Dashboard on this page, so click the JIRA icon on the Dashboard to which you want to connect JIRA.

スクリーンショット 2019-07-08 17.27.15.png

2. Issue API token from JIRA side. Click on the [Atlassian account page] to go to the screen on the JIRA side.

image4.png

3, Click on the [Create API token] button, a modal will be displayed called Create your API token. Enter ‘Sleeek’ (optional) for the Label and click the [Create] button.

image1.png

4. A new API token will be issued, so be sure to copy it to the clipboard.

image2.3.png

5,Return to the Sleeek screen, enter the URL of your JIRA instance, Your Atlassian account email address, and the API token, and click the [Next] button.

image3.png

6. Check the checkbox of the projects of JIRA you want to connect to the Dashboard, and click the [Pick up] button.

image5.png

7.The integration is completed. Sleeek analysis program starts running in order to create panels in the project view. It takes at least several minutes (depends on the data size of your repository).

Connect with Slack

How to connect to Slack

Slack is a necessary tool for software developers to help to facilitate communication on a daily basis. Sleeek helps to make Slack communication even better. Sleeek gets data from your Slack workspaces using a Slack Chat Bot called “Shep” (Fig. 1). Once Shep is installed in your Slack workspace, it gathers a list of channels in the workspace. From there, you can select channel members in your project which Shep will begin to have communication with.

After you connect Sleeek to Slack, you can enjoy:

・“How’s each member doing?” panel in order to check each member’s current status

・“Is your team hot enough?” panel (to be published in July) to check each member’s contribution activity.

This page explains how to connect Sleeek with your workspace in Slack.

Fig. 1: Diagram of the Slack connection

Fig. 1: Diagram of the Slack connection

Setup Procedure

1. Login to Sleeek, then go to the “Settings” page. If you haven’t created any dashboards yet, please create a dashboard first. Pick a dashboard you want to connect with Slack (the dashboard already connected with Slack has colored Slack icon with a green button).

Step1.png

2. Install the Slack chat bot “Shep” by clicking the “Connect with tool” button.

Step2.png

3. You are then transferred to a setting page in Slack. Select a slack workplace you want to connect to Sleeek, then “authorize” Shep to do following items:

  • Confirm your identity on <User Name>

  • Access information about your channels

  • Add slash commands and add actions to messages (and view related content)

Note that you need several access rights to install the Slack bot into your workplace. If you have any errors related with access levels, please contact an administrator of your workspace.

Step3.png

4. You will be then redirected back to the Sleeek web site. The list of channels you can access are shown. Please pick one of channels that you want to connect to Sleeek. Shep will then start communication with members who join this channel.

step4.png

5. Almost done! The final step is the configuration of the Sleeek panel called “How’s each member doing?”. For this panel, the Slack chat bot, Shep, is asking the overall status to each member. You can configure:

  • Who should or shouldn’t Shep communicate with? (Default: all members who join the channel)

  • When should Shep ask a question? (Default: 5:00PM)

Step5.png

6. Congratulations! Your Slack channel is connected to Sleeek. If you go back to the Setting view, you can see the Slack icon has green button. It means your Slack channel is successfully connected.

Now you can confirm each member’s status on the “How’s each member doing?” panel. (Of course, it takes at least one day to show each member’s answers to the question). Shep only has this function right now, but will be updated to have more useful functions for your software project. Stay tuned!

Step6.png

Connect with GitLab

How to connect to GitLab

GitLab is a Git base repository management tool, and also provides issue-tracking and CI/CD pipeline features, developed by GitLab Inc. Sleeek connects to your GitLab with the OAuth2 protocol (Fig. 1) in order to get source code information including its historical transition data, and issue information if you use issue-tracking feature. Using these data, Sleeek shows productivity of each member, relationship between source code and issue, review comments of every code committed to the repository by an automated source code review tool, etc.

GitLab_conect_figs.png

Setup Procedure

1. Login to Sleeek, then go to the “Settings” page. If you haven’t created any dashboards yet, please create a dashboard first. Click GitLab icon in a dashboard you want to connect to GitLab (the dashboard already connected to GitLab has colored GitLab icon with a green button).

step1.png

2. If you create a new dashboard, you will see the Dashboard setup page. Please select GitLab, then press Next.

image5.png

3. Please input your GitLab server URL and click the ‘Next’ button. If it is not able to access your Gitlab repositories please contact your network administrator. And please note: internet access is required to set up with Sleeek.

image4.png

4. To connect to your Gitlab repositories, you need to install Gitlab OAuth Applications on your Gitlab account. In screen below, please click ‘Copy’ button to copy Redirect URL in (1) and Click ‘Install App via GitLab’ in (2).
After that, the Gitlab set up screen will open up in the next tab; get your ApplicationID and Secret from this page.

image3.png

5. Please continue to the new tab (Applications setup page).

Enter your preferred name and Redirect URL which you copied from Sleeek. Check the ‘API’  and ‘read_repository’ boxes and finally click ‘Save Application’.

image1.png

6. You also need to enter  'Application ID' and 'Secret' from the Gitlab for dashboard configuration.Please make sure to note your Application ID and Secret. You can take note when using copy and paste buttons easily.

image2.png

7. Let’s go back to the Sleeek site and enter copied 'Application ID' and 'Secret' in Sleeek web site. Click Next to finish this integration process.

image6.png

8. The integration is completed. Sleeek analysis program starts running in order to create panels in the project view. It takes at least several minutes (depends on the data size of your repository).

Instruction Video

Connect with GitHub

How to connect to GitHub

GitHub is a web-based hosting for repository management tool using Git. It also provides issue-tracking, bug tracking, and wiki for every project. Sleeek connects to your GitHub with Sleeek GitHub App (Fig. 1) in order to get source code information including its historical transition data, and issue information if you use issue-tracking feature. The Sleeek GitHub App has only read permition to your repository. If you need more information about GitHub App, please refer to GitHub Apps on your GitHub organizations.
Using these data, Sleeek shows productivity of each member, relationship between source code and issue, review comments of every code committed to the repository by an automated source code review tool, etc.

Fig 1. Overview of GitHub integration

Fig 1. Overview of GitHub integration

Procedure

1. Login to Sleeek, then go to the “Settings” page. If you haven’t created any dashboards yet, please create a dashboard first. Click GitHub icon in a dashboard you want to connect to GitHub (the dashboard already connected to GitHub has colored GitHub icon with a green button).

step1.png

2. If you create a new dashboard, you will see this Dashboard setup page.  Please select GitHub, then press “Next”.

image5.png

3. To connect with your GitHub repositories, you need to install Sleeek GitHub Apps on your GitHub organizations. Click ‘Install Apps via GitHub’. Then move to setup page on GitHub.

image3.png

4. In the new tab, please click ‘Install” button on top right.

image4.png

5. In this screen, please select the Organization name of which you would like to install Sleeek onto.
Note : Each Organization require this process. If you would like to apply multiple organizations, please setup the following process for each organization.

6. Select the appropriate repository in your organization. If you want to apply all, check ‘All repository’. If you want to apply any repository, check ‘Only select repository’.

Once finished, click ‘Install’ button.

7. This is end of the setup process in GitHub’s side. Sleeek analysis program starts running in order to create panels in the project view. It takes at least several minutes (depends on the data size of your repository).

Add a new organization

If you would like to add a new organization which is not installed into Sleeek yet, you need to proceed with the following process.

※ In the current version, the dashboard is not able to link with multiple GitHub organizations.  
If your dashboard has already linked with another GitHub organization, you will not be able to connect. If you want to monitor your GitHub organization which is already linked with Sleeek, create a new dashboard and link that GitHub organization.
Click ‘Dashboard Setting’ on the bottom left corner of the Dashboard screen.

Then, click the GitHub Logo in the Dashboard Name row.

Click ‘Install the Sleeek App on other Organization’ in the screen below.

※ If another GitHub organization member has already installed Sleeek in the GitHub organization you want to link to, you can select in Select Org.

image2.png

Click ‘Install App via GitHub’. Then move to new tab, setup screen on Github side.

image3.png

Click ‘Install’ button in the screen below.
※ If any of your GitHub organization already has Sleeek installed, the install button may be changed to the ‘Configure’ button, but please proceed as is.

image4.png

You can see organization list. Please select organization you want to install.
Note: If Sleeek is already installed, it shows ‘Configure’ in organization.

image6.png

Choose repository in specific organization.

If you want to apply all, check ‘All repository’. If you want to apply any repository, check ‘Only select repository’ and select specific repository you want to apply.
Once finished, click ‘Install’ button.

This is end of the setup process for the GitHub side.
Let’s back to Sleeek and continue to setup in Sleeek.

How to remove Sleeek connection from Tools

This section describes how to remove tools that are already connected.
Please read the article according to the index below.

INDEX
1.How to remove Sleeek connection from GitLab
2.How to remove Sleeek connection from GitHub
3.How to remove Sleeek connection from Slack
4.How to remove Sleeek connection from JIRA

1.How to remove Sleeek connection from GitLab

1_1.Go on to “Settings” page in the Sleeek website, and click a GitLab icon that you want to disconnect. Please click “Delete” button in the following page.

スクリーンショット 2019-07-04 12.35.21.png

1_2.Login your GitLab server. Click your user icon at the top right corner, then select “Settings”.

図2.png

1_3.Click ”Applications” on the side menu, and delete ”sleeek” records in “Your application” table.

スクリーンショット 2019-07-04 12.51.59.png

2.How to remove Sleeek connection from GitHub

2_1.Go on to “Settings” page in the Sleeek website, and click a GitHub icon that you want to disconnect. Please click “Delete” button in the following page.

スクリーンショット 2019-07-04 13.18.35.png

2_2.Go on to “Settings” page in the Sleeek website, and click a GitHub icon that you want to disconnect. Please click “Delete” button in the following page.

図4.png

2_3.Click ”Applications” on the side menu, click “Installed GitHub Apps” tab, and click “Configure” button of ”Sleeek”.

スクリーンショット 2019-07-04 13.24.50.png

2_4.Click “Uninstall” in the Sleeek Application page.

スクリーンショット 2019-07-04 13.24.59.png

2_5.You will automatically go back to “Applications” page. Click “Authorized GitHub Apps” Tab, and click ”Revoke” button of “Sleeek”.


3.How to remove Sleeek connection from Slack

3_1.Go on to “Settings” page in the Sleeek website, and click a GitHub icon that you want to disconnect. Please click the “Delete” button in the following page.

スクリーンショット 2019-07-04 13.18.55.png

3_2.Go on your Slack Application page, and login your Slack workspace. After login, click “Manage” on the top menu.

スクリーンショット 2019-07-04 13.34.29.png

3_3.Type “Shep” in the “Title includes” search field, then click the Shep entry.

スクリーンショット 2019-07-04 13.34.40.png

3_4.In the Shep settings page, you can find “Remove App” button at the bottom of the page. Please click it.

スクリーンショット 2019-07-04 13.36.57.png

4.How to remove Sleeek connection from JIRA

1_1.Go on to ‘Settings’ page in the Sleeek website, and click a JIRA icon that you want to disconnect. Please click “Delete” button in the following page.

スクリーンショット 2019-07-08 19.37.10.png

1_2.Login your JIRA account. Click your user icon at the top right corner, then select ‘Profile’ and Click ‘Manage profile’ in next page.

スクリーンショット 2019-07-08 19.57.52.png

1_3.Click ‘Security’ on the side menu, and Click ‘Create and manage API tokens’ in next page.

スクリーンショット 2019-07-08 19.55.41.png

1_4.Let's revoke the API token of 'sleeek'.

スクリーンショット 2019-07-08 19.53.35.png