https://github.com/tomoyanakano/spreadsheet-github-integration
Google App Script enabling to integrate google spreadsheet with github
https://github.com/tomoyanakano/spreadsheet-github-integration
Last synced: 6 months ago
JSON representation
Google App Script enabling to integrate google spreadsheet with github
- Host: GitHub
- URL: https://github.com/tomoyanakano/spreadsheet-github-integration
- Owner: tomoyanakano
- Created: 2022-02-09T09:55:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-27T12:11:38.000Z (over 3 years ago)
- Last Synced: 2025-02-04T11:48:11.788Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 135 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Github Spreadsheet Integration
This project makes it possible to integrate github issues with google spreadsheet.
Demo sheet is [here](https://docs.google.com/spreadsheets/d/1lSQ_NTh4glafmBLqjYhmASdUDtkid6vmB0z9V0ThuNI/edit?usp=sharing)
# Getting Started
These instructions will get you a copy of the project up and running on your spreadsheet.
## Prerequisites
What things you need to install the software and how to install them
```
//installing clasp and login your google account
clasp version
clasp login
```
You also need to create spreadsheet like [sample sheet](https://docs.google.com/spreadsheets/d/1lSQ_NTh4glafmBLqjYhmASdUDtkid6vmB0z9V0ThuNI/edit?usp=sharing)
※If your spreadsheet's row and column is different from this sample, it would fail to add issues to github.
## Installing and Deployment
A step by step series of examples that tell you how to get a running on your spreadsheet
### Installing
installing npm packages
```
npm install
```
### Deployment
setting your Google App Script Id to .clasp.json
```
{"scriptId":""}
```
setting your Github info to Script Properties
import setProperties from setProperties.ts to index.ts, and execute with your github info in main function like below.
```
// setProperties.ts
const main = () => {
setProperties(
"YOUR GITHUB ACCESS TOKEN",
"YOUR GITHUB ACCOUNT NAME",
"YOUR GITHUB REPOSITORY NAME"
)
}
```
※ Setting Properties is required once, so you can delete these codes if you set value.
Finally, you can deploy to your spreadsheet and then you have to execute main function in order to set properties.
```
npm run deploy
```
### how to use without script properties
if you would like to use this without script properties, you need to change these codes.
from
```
// main.ts
const ACCESS_TOKEN = PROPERTIES.getProperty("accessToken");
const USER_NAME = PROPERTIES.getProperty("username");
const REPOSITORY = PROPERTIES.getProperty("repository");
```
to
```
const ACCESS_TOKEN = "YOUR GITHUB ACCESS TOKEN"
const USER_NAME = "YOUR GITHUB ACCOUNT NAME"
const REPOSITORY = "YOUR GITHUB REPOSITORY NAME";
```
## Customize
If you would like to customize sheet, please change these codes.
```
// main.ts
// spreadSheet
const SHEET = SpreadsheetApp.getActive().getSheetByName("issues");
const LABEL_ROW = 5;
const CHECK_COL = 1;
const STATE_COL = 2;
const TITLE_COL = 3;
const LABEL_COL = 4;
const BODY_COL = 5;
const ASSIGNEE_COL = 6;
const URL_COL = 7;
```
# Contribution
please feel free to add issue and create pull request!!