Skip to content

Commit

Permalink
Merge pull request #415 from watermint/current
Browse files Browse the repository at this point in the history
Release 73
  • Loading branch information
watermint committed Sep 14, 2020
2 parents d540fc2 + 0cc38ef commit 45550b6
Show file tree
Hide file tree
Showing 484 changed files with 23,607 additions and 3,533 deletions.
5 changes: 3 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: 2
jobs:
build:
docker:
- image: circleci/golang:1.14
- image: circleci/golang:1.15
working_directory: /go/src/github.com/watermint/toolbox
steps:
- checkout
Expand All @@ -12,13 +12,14 @@ jobs:
- run: ./.circleci/prepare.sh
- run: go get github.com/GeertJohan/go.rice
- run: go get github.com/GeertJohan/go.rice/rice
- run: go get github.com/google/go-licenses
- run: ./build.sh
- store_artifacts:
path: /go/src/github.com/watermint/toolbox/dist

test:
docker:
- image: circleci/golang:1.14
- image: circleci/golang:1.15
working_directory: /go/src/github.com/watermint/toolbox
steps:
- checkout
Expand Down
18 changes: 8 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
.DS_Store
.dropbox
.coverprofile
tbx.runbook
*.afdesign
*.appkeys
*.iml
*.jks
*.key
*.pem
*.prof
*.secret
*.tokens
*.afdesign
*.appkeys
*.pem
*.key
*.jks
.DS_Store
.coverprofile
.dropbox
/.idea
/build
/dist
/vendor
/resources/keys
/test/dev
14 changes: 9 additions & 5 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Configure environment variable `TOOLBOX_APPKEYS` like below
To build an executable, please use Docker like below.

```bash
$ docker build -t toolbox . && rm -fr /tmp/dist && docker run -v /tmp/dist:/dist:rw --rm toolbox
$ docker-compose -f docker-compose.yml build && docker-compose -f docker-compose.yml run build
```

# Enhance code
Expand All @@ -64,11 +64,11 @@ mapped into `file.copy.<key>`, and `file.copy_vo.<key>`.

## Before commit

Please run command `dev preflight` to ensure all message resources and documents are available.
Please run command `dev build preflight` to ensure all message resources and documents are available.

```bash
$ cd /path/to/PROJECT_ROOT
$ go run tbx.go dev preflight
$ go run tbx.go dev build preflight
```

# Test process
Expand Down Expand Up @@ -104,5 +104,9 @@ $ go run tbx.go dev release candidate

## Publish Release

Please run `publish_release.sh` on macOs, to test binaries.
The script will generate draft release notes when all tests succeed.
Please run command `dev release publish` to upload assets on to the github account, and create draft releases.

```bash
$ cd /path/to/PROJECT_ROOT
$ go run tbx.go dev release publish
```
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM golang:1.14
FROM golang:1.15

RUN apt-get update -y
RUN apt-get upgrade -y
Expand All @@ -11,6 +11,7 @@ RUN go get github.com/GeertJohan/go.rice/rice
RUN go get github.com/derekparker/delve/cmd/dlv
RUN go get golang.org/x/tools/cmd/cover
RUN go get github.com/jstemmer/go-junit-report
RUN go get github.com/google/go-licenses
RUN mkdir /dist
ENV PROJECT_ROOT=/app

Expand Down
88 changes: 57 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,19 @@ brew tap watermint/toolbox
brew install toolbox
```

# Security and privacy

## Information Not Collected

The watermint toolbox does not collect any information to third-party servers.

The watermint toolbox is for interacting with the services like Dropbox with your account. There is no third-party account involved. The Commands stores API token, logs, files, or reports on your PC storage.

## Sensitive data

Most sensitive data, such as API token, are saved on your PC storage in obfuscated & made restricted access. However, it's your responsibility to keep those data secret.
Please do not share files, especially the `secrets` folder under toolbox work path (`C:\Users\<your user name>\.toolbox`, or `$HOME/.toolbox` by default).

# Usage

`tbx` have various features. Run without an option for a list of supported commands and options.
Expand All @@ -53,44 +66,29 @@ Usage:
Available commands:
===================
config watermint toolbox configuration
connect Connect to the account
file File operation
filerequest File request operation
group Group management
license Show license information
member Team member management
sharedfolder Shared folder
sharedlink Shared Link of Personal account
team Dropbox Business Team
teamfolder Team folder management
version Show version
Command Description Notes
config watermint toolbox configuration
connect Connect to the account
file File operation
filerequest File request operation
group Group management
license Show license information
member Team member management
sharedfolder Shared folder
sharedlink Shared Link of Personal account
team Dropbox Business Team
teamfolder Team folder management
version Show version
```

# Commands

## Utilities

| Command | Description |
|-------------------------------------------------------------|--------------------------------------------------|
| [config disable](doc/generated/config-disable.md) | Disable a feature. |
| [config enable](doc/generated/config-enable.md) | Enable a feature. |
| [config features](doc/generated/config-features.md) | List available optional features. |
| [file dispatch local](doc/generated/file-dispatch-local.md) | Dispatch local files |
| [job history archive](doc/generated/job-history-archive.md) | Archive jobs |
| [job history delete](doc/generated/job-history-delete.md) | Delete old job history |
| [job history list](doc/generated/job-history-list.md) | Show job history |
| [job log jobid](doc/generated/job-log-jobid.md) | Retrieve logs of specified Job ID |
| [job log kind](doc/generated/job-log-kind.md) | Concatenate and print logs of specified log kind |
| [job log last](doc/generated/job-log-last.md) | Print the last job log files |
| [license](doc/generated/license.md) | Show license information |
| [version](doc/generated/version.md) | Show version |

## Dropbox (Individual account)

| Command | Description |
|-------------------------------------------------------------------------|--------------------------------------------------|
| [connect user_file](doc/generated/connect-user_file.md) | Connect to user file access |
| [dev benchmark upload](doc/generated/dev-benchmark-upload.md) | Upload benchmark |
| [file compare account](doc/generated/file-compare-account.md) | Compare files of two accounts |
| [file compare local](doc/generated/file-compare-local.md) | Compare local folders and Dropbox folders |
| [file copy](doc/generated/file-copy.md) | Copy files |
Expand All @@ -106,9 +104,10 @@ Available commands:
| [file restore](doc/generated/file-restore.md) | Restore files under given path |
| [file search content](doc/generated/file-search-content.md) | Search file content |
| [file search name](doc/generated/file-search-name.md) | Search file name |
| [file sync preflight up](doc/generated/file-sync-preflight-up.md) | Upstream sync preflight check |
| [file size](doc/generated/file-size.md) | Storage usage |
| [file sync down](doc/generated/file-sync-down.md) | Downstream sync with Dropbox |
| [file sync online](doc/generated/file-sync-online.md) | Sync online files |
| [file sync up](doc/generated/file-sync-up.md) | Upstream sync with Dropbox |
| [file upload](doc/generated/file-upload.md) | Upload file |
| [file watch](doc/generated/file-watch.md) | Watch file activities |
| [filerequest create](doc/generated/filerequest-create.md) | Create a file request |
| [filerequest delete closed](doc/generated/filerequest-delete-closed.md) | Delete all closed file requests on this account. |
Expand Down Expand Up @@ -216,3 +215,30 @@ Available commands:
| [services google mail message processed list](doc/generated/services-google-mail-message-processed-list.md) | List messages in processed format. |
| [services google mail thread list](doc/generated/services-google-mail-thread-list.md) | List threads |

## Asana

| Command | Description |
|-------------------------------------------------------------------------------------------------|--------------------------------|
| [services asana team list](doc/generated/services-asana-team-list.md) | List team |
| [services asana team project list](doc/generated/services-asana-team-project-list.md) | List projects of the team |
| [services asana team task list](doc/generated/services-asana-team-task-list.md) | List task of the team |
| [services asana workspace list](doc/generated/services-asana-workspace-list.md) | List workspaces |
| [services asana workspace project list](doc/generated/services-asana-workspace-project-list.md) | List projects of the workspace |

## Utilities

| Command | Description |
|-------------------------------------------------------------|--------------------------------------------------|
| [config disable](doc/generated/config-disable.md) | Disable a feature. |
| [config enable](doc/generated/config-enable.md) | Enable a feature. |
| [config features](doc/generated/config-features.md) | List available optional features. |
| [file dispatch local](doc/generated/file-dispatch-local.md) | Dispatch local files |
| [job history archive](doc/generated/job-history-archive.md) | Archive jobs |
| [job history delete](doc/generated/job-history-delete.md) | Delete old job history |
| [job history list](doc/generated/job-history-list.md) | Show job history |
| [job log jobid](doc/generated/job-log-jobid.md) | Retrieve logs of specified Job ID |
| [job log kind](doc/generated/job-log-kind.md) | Concatenate and print logs of specified log kind |
| [job log last](doc/generated/job-log-last.md) | Print the last job log files |
| [license](doc/generated/license.md) | Show license information |
| [version](doc/generated/version.md) | Show version |

0 comments on commit 45550b6

Please sign in to comment.