Skip to content

Latest commit

 

History

History
 
 

github

README.md

Sample add-on: GitHub Reader

This is a sample add-on that demonstrates using external services to bring rich information into Gmail, as well as contextual triggering based on email content. It triggers in response to messages containing links GitHub issues or pull requests and displays additional relevant information.

Screenshot

Note: This is not an official Google product.

Before you begin

If you're new to add-on development or Apps Script, try the quickstart before proceeding.

This sample requires the following:

  • Node.js is installed.
  • clasp is installed. clasp is a tool for managing Apps Script projects.
  • A GitHub account, as well as notification emails for an issue or pull request from from a hosted repository.

Downloading the sample

Download the sample app and navigate into the app directory:

  1. Clone the Gmail add-ons samples, to your local machine:

    git clone https://github.com/googlesamples/gmail-add-ons-samples.git

    Alternatively, you can download the sample as a zip file and extract it.

  2. Change to the sample directory:

    cd gmail-add-ons-samples/github

  3. Initialize the project:

    npm install

  4. Bundle the dependencies:

    npm run build

Deploy the add-on

Deploy the add-on by following these steps:

  1. Create a new project:

    clasp create "Git Info"

  2. Push the code:

    clasp push

  3. Tag a version:

    clasp version 'Push from github'

  4. Deploy the add-on:

    clasp deploy 1 'test'

  5. Verify the deployments:

    clasp deployments

Note the deployment ids. There will be two deployments, one for the tagged version, another for the @HEAD version. Use the @HEAD deployment when installing the add on if you intend to modify or experiment with the code.

Configure GitHub credentials

Access the GitHub API requires registration. To register your own application:

  1. Open the script editor:

    clasp open

  2. Get the script id by clicking on File > Project properties and note the value of the Script ID field.

  3. Follow GitHub's guide to create an OAuth Application. Use the value https://script.google.com/macros/d/{SCRIPT_ID}/usercallback for the Authorization callback URL, replacing {SCRIPT_ID} with the script id located in the previous step.

  4. Create a script property with the credentials:

    a. Click on File > Project properties > Script properties.

    b. Click Add row.

    c. Enter the property name githubCredentials.

    d. Click on the blank area in the Value column.

    e. Enter the value below, subsituting the {CLIENT_ID} and {CLIENT_SECRET} with the values provided by GitHub.

    {"clientId": "{CLIENT_ID}", "clientSecret": "{CLIENT_SECRET}" }

    f. Click Save.

Install the add-on

One the add-on is deployed, install the add-on on your account using these steps:

  1. Open the Gmail add-on settings tab.

  2. In the Add-ons tab, ensure that you have selected the Enable developer add-ons for my account checkbox.

  3. Paste your add-on's deployment ID into the Install developer add-on textbox and click Install.

  4. In the Install developer add-on dialog that appears, click the checkbox to indicate that you trust this developer (yourself), then click Install.

The add-on appears in the Developer add-ons list at this point. The Enable debugging information checkbox (which is checked by default) instructs Gmail to create and display an error report card when script or runtime errors occur during the execution of the add-on.

Run the add-on

  1. Open Gmail. If Gmail was open prior to enabling the add-on, you may need to refresh the tab.

  2. Open a message in Gmail.

  3. The add-on should place a contextual card on the right-side of the window, with a message asking for authorization. Click the Authorize access link to open a dialog where you can authorize the add-on.

  4. Select the account that should authorize the add-on.

  5. The next dialog may inform you that the app is not verified. In this case you can proceed by doing the following:

    a. Click Advanced.

    b. At the bottom of the dialog, click Go to Git Info (unsafe).

    c. In the new dialog, type "Continue" into the text field, then click Next.

  6. Read the notice in the next dialog carefully, then click Allow.

  7. Once authorized, the add-on should automatically refresh and start operating.

Contributing

Please read our guidelines for contributors.

License

This sample is licensed under the Apache 2 license.