Skip to content
This repository has been archived by the owner on Jan 22, 2019. It is now read-only.

Commit

Permalink
Adding Dropbox and Github documentation to Readme file
Browse files Browse the repository at this point in the history
Signed-off-by: Lior Haim <[email protected]>
  • Loading branch information
20lives committed Jul 30, 2018
1 parent 5f59835 commit 0f697c3
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,20 @@ hck-ci ALL=(ALL) NOPASSWD:ALL
### Images preperation
This is similar to making regular HLK/HCK studio and clients images with with few additionals configurations, detailed instrutions available at [HLK-Setup-Scripts](https://github.com/daynix/HLK-Setup-Scripts)

### Dropbox integration
auto_hck allows integration with Dropbox, automatically uploading results and logs to specific location.
to do that you will need to create auth2 token
1. go to https://www.dropbox.com/developers/apps and click on 'Create app'
2. select 'Dropbox API', 'Full Dropbox' access type and give it a unique name.
3. click on 'Generated access token' and copy the token to config.json file.

### Github integration
when specifing a pull request auto_hck can mark test results on github and link to dropbox logs folder.
to do that you will need to create a personal access token.
1. go to https://github.com/settings/tokens and click on 'Generate new token'
2. give it a name, select: repo:status and click 'Generate token'
3. copy the token to the config.json file.

### Configuration
There are 3 diffrenet JSON files for configurations, examples included in the files:
* `config.json` is the general configuration file which holds the paths to the dependencies stated above.
Expand Down

0 comments on commit 0f697c3

Please sign in to comment.