├── LICENSE
├── README.ja.md
├── README.md
├── cli
└── ssbird
│ ├── README.ja.md
│ ├── README.md
│ ├── cmd
│ ├── init.go
│ ├── root.go
│ └── sync.go
│ ├── go.mod
│ ├── go.sum
│ └── main.go
├── docs
├── drawio
│ └── ssbird-role.drawio
└── images
│ ├── dark.jpg
│ ├── ignore-cell.jpg
│ ├── light.jpg
│ ├── logo.png
│ ├── ssbird-role.jpg
│ └── ssbird.gif
├── examples
├── cli-config.json
└── extension-config.json
├── extension
├── app
│ ├── css
│ │ ├── popup.css
│ │ ├── selectize.dark.css
│ │ └── selectize.default.css
│ ├── icons
│ │ ├── 128.png
│ │ ├── 16.png
│ │ └── 48.png
│ ├── js
│ │ ├── all.min.js
│ │ ├── background.js
│ │ ├── contents.js
│ │ ├── jquery-3.5.0.min.js
│ │ ├── popup.js
│ │ ├── selectize.min.js
│ │ └── utils.js
│ ├── manifest.json
│ └── popup.html
├── host
│ ├── go.mod
│ ├── go.sum
│ └── main.go
└── installer
│ ├── mac
│ ├── host
│ │ └── com.yukiarrr.ssbird.json
│ └── install.command
│ └── windows
│ ├── host
│ └── com.yukiarrr.ssbird.json
│ └── install.bat
└── gas
├── apply.gs
└── sync.gs
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2020 yukiarrr
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.ja.md:
--------------------------------------------------------------------------------
1 |
4 |
5 | This is the master data management tool that made it possible to do from the creation of the data to the reflection **only in Chrome** by using Chrome Extension and Spreadsheet.
6 |
7 |
8 |
9 | ## Table of contents
10 |
11 | - [Overview](#overview)
12 | - [Getting started](#getting-started)
13 | - [Administrator only](#administrator-only)
14 | - [All members](#all-members)
15 | - [About `extension-config.json`](#about-extension-configjson)
16 | - [How to use](#how-to-use)
17 | - [Support dark mode](#support-dark-mode)
18 | - [Parameter description](#parameter-description)
19 | - [How to reflect a sheet directly](#how-to-reflect-a-sheet-directly)
20 | - [How to merge and reflect sheets](#how-to-merge-and-reflect-sheets)
21 | - [How to reflect data from multiple Spreadsheets](#how-to-reflect-data-from-multiple-spreadsheets)
22 | - [How to create Pull Request](#how-to-create-pull-request)
23 | - [Rules for merging sheets and converting csv](#rules-for-merging-sheets-and-converting-csv)
24 | - [Basic rules](#basic-rules)
25 | - [Rules for merging sheets](#rules-for-merging-sheets)
26 |
27 | ## Overview
28 |
29 | The most common way to manage master data is to create data in Excel or Spreadsheet, and reflect it to GitHub or database.
30 | Of these, SSBird minimizes the cost of managing master data by taking care of the process of creating data and pushing it to GitHub, except for parts that are dependent on each project's development environment, such as reflecting database.
31 |
32 |
33 |
34 | It also has features for merging sheets and creating Pull Request in consideration of parallel work by multiple people and data checking in CI.
35 | As an operational flow, we assume that when a csv is pushed to GitHub, it is imported into the database on CI/CD.
36 |
37 | ## Getting started
38 |
39 | ### Administrator only
40 |
41 | 1. Download the version of `SSBird-vX.X.X.Server.zip` you want to use from the [Releases](https://github.com/yukiarrr/SSBird/releases) and unzip it
42 | 2. Right-click on the location on Google Drive where you want to save the script and select `More > Google Apps Script`
43 | 3. Open the code editor, overwrite it with the code in `SSBird/gas/apply.gs` and save it
44 | 4. (optional) In line 8 of the `apply.gs`, enter your password like `const password = "Enter a random password here";` (it will be required as Apply Password when the Chrome extension is installed)
45 | 5. From the status bar above, go to `Resources > Advanced Google services...` and turn on "Google Sheets API"
46 | 6. From the status bar above, select `Publish > Deploy as Web app...` and change the permissions under "Who has access to the app" so that SSBird members can access it, then press "Deploy"
47 | 7. You will be asked to approve it after the update, so follow the instructions to approve it
48 | 8. Edit SSBird/examples/extension-config.json with reference to [this](#about-extension-configjson) (use the URL that appears after the completion of step 5 of this procedure for applyUrl)
49 | 9. Right-click on the configuration file in a location on Google Drive that your team members can access and upload the `extension-config.json` that you edited in `Upload files`
50 | 10. Right-click on the uploaded `extension-config.json`, select `Get shareable link`, and note the `XXXXXXX` part of `https://drive.google.com/file/d/XXXXXXX/view?usp=sharing` as the ID (it will be required as Config File Id when the Chrome extension is installed)
51 |
52 | ### All members
53 |
54 | 1. Download the version of `SSBird-vX.X.X.Client.zip` you want to use from the [Releases](https://github.com/yukiarrr/SSBird/releases) and unzip it
55 | 2. If you are a Mac user, right-click on `SSBird/extension/installer/mac/install.command`, hold down the command key and select "Open", which will bring up a dialog, then select "Open"
56 | 3. If you are a Windows user, double-click on `SSBird/extension/installer/windows/install.bat`
57 | 4. Please log in with your administrator-designated GitHub account
58 | 5. Please refer to [this page](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) and check the "repo" box in step 7 of the reference, and then issue the GitHub access token
59 | 6. Go to `chrome://extensions`, turn on developer mode in the upper right corner, and select `SSBird/extension/app` under "LOAD UNPACKED"
60 | 7. Please log in with your administrator-designated Google account
61 | 8. When you go to Spreadsheet screen or the folder where Spreadsheet is located in Google Drive, you will be able to press the SSBird icon in the upper right corner of Chrome
62 | 9. You will be asked for information, so enter it (use the GitHub Access Token you got in step 4 of this procedure)
63 | 10. Config File Id and Apply Password should be told to you by your administrator (if omitted, Apply Password is not necessary)
64 |
65 | ### About `extension-config.json`
66 |
67 | ```jsonc
68 | {
69 | // URLs that can be obtained after publishing a web application in apply.gs
70 | "applyUrl": "https://script.google.com/XXXXXXX/exec",
71 |
72 | // URL of the GitHub repository to push
73 | // Please give the user who issues the access token more than Write permission
74 | "repositoryUrl": "https://github.com/XXXXXXX/XXXXXXX",
75 |
76 | // The path from this ID folder to Spreadsheet will be the path on GitHub
77 | // The ID of the folder is the URL in the state of opening the folder with a browser, and
78 | // https://drive.google.com/drive/u/0/folders/XXXXXXX
79 | // XXXXXXX part is applicable
80 | "rootFolderId": "XXXXXXX"
81 | }
82 | ```
83 |
84 | ## How to use
85 |
86 | ### Support dark mode
87 |
88 | |light|dark|
89 | |:-:|:-:|
90 | |
|
|
91 |
92 | ### Parameter description
93 |
94 | |Parameter|Description|
95 | |:-:|:-:|
96 | |Apply Spreadsheets|Spreadsheets that are subject to Apply. Automatic selection on Spreadsheet and multiple selections on Google Drive.|
97 | |Target Sheet|The sheet to be pushed to. If it doesn't exist, it will be created automatically. The name of the branch to be pushed is the same as the name of the sheet.|
98 | |Merge Sheets|The sheet to merge Target Sheet. Multiple sheets can be selected, in which case, the sheets are merged in the order of input.|
99 | |Commit Message|Commit message.|
100 | |Parent Branch|The name of the branch to use as a parent if the branch with Target Sheet name does not exist and is newly created.|
101 | |Create Pull Request|When it is on, the sheet specified in Target Sheet is not updated and Pull Request is created instead.|
102 |
103 | ### How to reflect the sheet directly
104 |
105 | 1. Create the sheet and data that you want to reflect in Spreadsheet
106 | 2. Press the SSBird icon at the top right
107 | 3. Select the sheet you want to reflect in the "Target Sheet"
108 | 4. press "Apply"
109 | 5. if "Success 🎉" comes up, it's a success!
110 |
111 | ### How to merge and reflect sheets
112 |
113 | 1. In Spreadsheet, create a sheet to overwrite the data separately from the sheet you want to reflect (please write a column in the sheet for overwriting)
114 | 2. Please write only the data you want to overwrite in the sheet you want to overwrite
115 | 3. Select the sheet you want to reflect in the "Target Sheet"
116 | 4. Select the sheet describing the data to be overwritten in "Merge Sheets" (multiple selections are possible, and the data will be overwritten in the order of selection)
117 | 5. press "Apply"
118 | 6. if "Success 🎉" comes up, it's a success!
119 |
120 | ### How to reflect data from multiple Spreadsheets
121 |
122 | 1. Go to the Google Drive folder screen that contains Spreadsheet you want to reflect
123 | 2. In the 'Apply Spreadsheets' section, select Spreadsheet you want to reflect
124 | 3. As for "Target Sheet" and "Merge Sheets", it is the same as [How to merge and reflect sheets](#how-to-merge-and-reflect-sheets), and is applied to all selected Spreadsheets
125 | 4. press "Apply"
126 | 5. if "Success 🎉" comes up, it's a success!
127 |
128 | ### How to create Pull Request
129 |
130 | 1. turn on the "Create Pull Request"
131 | 2. As for "Target Sheet" and "Merge Sheets", it is the same as [How to merge and reflect sheets](#how-to-merge-and-reflect-sheets)
132 | 3. press "Apply"
133 | 4. if "Success 🎉" comes up, it's a success! (In Pull Request, "Target Sheet" is base branch, "Merge Sheets" is head)
134 |
135 | ## Rules for merging sheets and converting csv
136 |
137 | ### Basic rules
138 |
139 | - If the Spreadsheet name is example, it will be example.csv on GitHub
140 | - If the target sheet name is develop, the csv will be pushed to the develop branch
141 | - Data columns should be written with no spaces on the left and top (A1,B1,C1...)
142 | - Cells with blank A columns or 1 rows will be ignored in both merging sheets and converting csv, so please use this when making notes (if you're making notes in D2, leave A2 or D1 blank)
143 |
144 |
