Try WSO2 Cloud for Free
Sign in

All docs This doc
Skip to end of metadata
Go to start of metadata

Problem

When there are multiple repositories under a single organization and the total number of repositories is high, it might be difficult to find all the issues that are reported. You will want to record all the issues in a single place.

Solution

In this guide, we explain how to use the Github connector to get details of the newly created Github issues (e.g., Repository Name, Issue Title, Issue Description, Issue status) for all the repositories under your account. We then add those details to a Google spreadsheet using the Google Spreadsheet connector.

How the solution works

The following diagram illustrates how the solution works:

Before you begin, follow the guides below to set up Github and Google Spreadsheets:

Let's get started.

  1. Go to WSO2 Cloud and sign up if you haven't done so already. The UI guides you through the signup process.
  2. Sign in to WSO2 Cloud and go to the Integration Cloud tab. Then, click ESB Compsite Application.
  3. Select the Local File System option and click Continue.
  4. Give an application name (e.g., GithubToSpreadsheet) and upload this CAR file.

    What is a CAR file? A Composite Application (CAR) is an archive file that has the collection of artifacts that you want to deploy in a WSO2 product instance. These artifacts are usually JAVA-based or XML configurations, designed differently for each product in the WSO2 Carbon platform. You can deploy these artifacts to generate services.

      

  5. You link to the Google spreadsheet and the Github account that you use in this scenario using environment variablesDownload this file and change the values of the variables according to your requirements.

     Click here to read more information about the environment variables used in this file...
    env.json file
    {
        "googlespreadsheet_accessToken" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "googlespreadsheet_refreshToken" : "xxxxxxxxxxxxxxxxxxxxxx",
        "googlespreadsheet_clientId" : "xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "googlespreadsheet_clientSecret" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "googlespreadsheet_apiUrl" : "https://sheets.googleapis.com/v4/spreadsheets",
        "googlespreadsheet_spreadsheetId" : "xxxxxxxxxxxxxxxxxxxx",
        "googlespreadsheet_range" : "Scenario!A2",
        "googlespreadsheet_valueInputOption" : "RAW",
        "github_apiUrl" : "https://api.github.com",
        "github_accessToken" : "xxxxxxxxxxxxxxxxxxxx",
        "github_mediaType" : "application/vnd.github+json",
        "github_owner" : "Biruntha",
        "github_repos" : "repo1,repo2",
        "github_milestone" : "*",
        "github_state" : "open",
        "github_assignee" : "user1",
        "github_creator" : "user2",
        "github_mentioned" : "user3",
        "github_labels" : "bug",
        "github_sort" : "created",
        "github_direction" : "asc",
        "github_perPage" : 200,
    	"task_interval_time" : 120
    } 

    Here's a description of the properties:

    • googlespreadsheet_accessToken: Access token through the OAuth2 playground.

    • googlespreadsheet_refreshToken: Refresh token to exchange with an access token.

    • googlespreadsheet_clientId: Value of the client id that you obtain via the Google developer console.

    • googlespreadsheet_clientSecret: Value of the client secret that you obtain via the Google developer console.

    • googlespreadsheet_apiUrl: The application URL of Google Sheet version v4.

    • googlespreadsheet_spreadsheetId: Unique value of the spreadsheet.

    • googlespreadsheet_range: The A1 notation of the values to retrieve.

    • googlespreadsheet_valueInputOption: How the input data should be interpreted. For more information, click here.

    • github_apiUrl: URL of the Github API. If not provided, it is set to https://api.github.com.

    • github_accessToken: Mandatory. The access token used to call the Github API methods.

    • github_mediaType:  Custom media type used by the API to let consumers choose the format of the data they wish to receive.

    • github_owner: Mandatory. The name of the owner of the repository.

    • github_repos: Mandatory. The name of the repositories. If you have multiple repos, pass them as a comma-separated list.

    • github_milestone: The milestone number. If an  integer  is passed, it should refer to a milestone number. If the string  *  is passed, issues with any milestone are accepted. If the string  none  is passed, issues without milestones are returned. The default is  *.

    • github_state: The state of the issues to return. Can be  open , closed , or  all . The default is open.

    • github_assignee: The user whose issues you want to list. Set to none to list issues with no assigned user and  *  for issues assigned to any user. The default is  *.

    • github_creator: The user that created the issue.

    • github_mentioned: A user mentioned in the issue.

    • github_labels: A comma-separated list of label names. For example,  bug,ui,@high.

    • github_sort: The field to use for sorting the results. Can be  created updated , or  comments . The default is created.

    • github_direction: The order in which items are sorted. Can be either  asc  or  desc . The default is desc.

    • github_perPage: Items per page that you want to retrieve. the default is 30.
    • task_interval_time: The interval time of the scheduled task in seconds. The default is 120 seconds.
  6. Click the  Advanced Setting... link, expand the Environment Variables section, and upload the JSON file that you created in the previous step.
  7. Click the Create button at the end of the form to complete creating the application.
  8. Note that you see the application's Overview page once the application is deployed in the Cloud.

    You have now created an application in WSO2 Integration Cloud. Let's see how to test the scenario.
  9. Go to your Github repository and create new issue with a description and some issue comments. Here's an example:
  10. Note the newly added issue details in the Google Spreadsheet that you linked to in step 7 above:

You have now used the WSO2 connectors in the Connector store to Export github issues to spreadsheet.  

Want to customize the default use case?

In this guide, you tried the solution on WSO2 Integration Cloud. You can do the same on-premise with your own WSO2 Enterprise Integrator instance. To modify the default scenario, see Modify the Default Github to Spreadsheet Scenario2.

  • No labels