GitHub commits integration with gmail

Overview

The provided sample includes:

• Generating GitHub API access tokens via OAuth 2.0.
• Authenticating and connecting to the GitHub API via Linx
• Send emails from Gmail for GitHub commits for a time period. This sample shows how Linx automatically sends an email from Gmail. Once this GitHub-Gmail integration is active, the sample sends out email from the Gmail account. This email can be directed to you or any others you want to alert containing the information concerning the commits you want to pass on.

---

Additional resources

• GitHub-Linx integration guide
• GitHub API authentication documentation
• GitHub API documentation
• Linx email configuration

---

Dependencies

Pre-requisites

• Linx Designer
• Github account

Linx Designer

This solution was developed in the Linx Designer v5.21.0.0

---

Setting up the sample

Register a new app on GitHub:

1. Register a new 'OAuth application' on GitHub
2. Configure the 'Authorization callback URL' to be: http://localhost:8080/oauth/token
3. Save your app.
4. Generate your client secret.
5. Copy the Client ID and Client Secret.

Configure the Solution's $.Settings:

1. Open the solution in your Linx Designer.

2. Edit the $.Settings values:

   • client_id: Your GitHub app’s Client ID
   • client_secret: Your GitHub app’s Client Secret
   • owner: Insert the owner of your repository. E.g From the link https://github.com/linx-software, linx-software is the owner.

3. Save the Solution.

Generate access tokens:

1. Start the debugger on the RESTHost service in the Linx Designer.
2. Make a request in your browser to http://localhost:8080/oauth/authorize
3. You will be redirected to the GitHub OAuth 2.0 access consent screen.
4. Authorize the connected application.
5. View success message.

---

Configure the Solution's $.Settings before sending emails

• Linx email configuration will help you get started with email plugin in Linx.

• To : $.Settings.receiver_mail

• Sender

  • From : $.Settings.sender_mail

• Credentials:

  • username : $.Settings.mail_username
  • password : $.Settings.mail_userpassword

Parameters:

• per_page: integer query. Results per page (max 100)
• since: start date of commits (e.g Yesterday's date or any other date before ‘until date below’: 2021-05-26)
• until: end date of commits (e.g Today's date : 2021-05-27)

---

Using the sample

Authentication

After your app has been successfully authorized, the access token is stored in a local text file.

Requests are authenticated via a Bearer access token included in the Authorization header of each request.

The token is retrieved from the file before each request is made.

Making requests

When making requests to the GitHub, you must also include the following header:

User-Agent: Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.111 YaBrowser/16.3.0.7146 Yowser/2.5 Safari/537.36

---

Utilities samples

GetReposForOwner

Lists repositories for the specified organization.

https://docs.github.com/en/rest/reference/repos#list-organization-repositories

GetCommits

The Repo Commits API supports listing, viewing, and comparing commits in a repository.

https://docs.github.com/en/rest/reference/repos#list-commits

Parameters:

Parameter	Type
repo	string query	Repositories' name
since	string query	Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
until	string query	Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
per_page	integer query	Results per page (max 100). Default: 30.

MailCommitForRepo

The function uses the repositories' list and commit list from the above function and mail the commit details to the recipient.

Running the Sample

Click on the function named RUN Enter parameters as follows:

• Per_page: 1
• Since: start date of commits (e.g Yesterday's date or any other date before ‘until date below’: 2021-05-26)
• Until: end date of commits (e.g Today's date : 2021-05-27)