more info in README
This commit is contained in:
Родитель
1d61ee3c2e
Коммит
bb94dbb635
35
README.md
35
README.md
|
@ -5,7 +5,14 @@ projects
|
|||
|
||||
## Basic Usage
|
||||
|
||||
### Install Requirements
|
||||
### Requirements
|
||||
|
||||
This project does not have any major requirements. The only requirement is
|
||||
`Fabric` if you choose the Fabric way of using this project. Otherwise, you
|
||||
don't even need that. The other way of using this project is using the Shell
|
||||
script that does the same thing the Fabric script does.
|
||||
|
||||
If you want to go the Fabric way, run:
|
||||
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
|
@ -14,13 +21,13 @@ pip install -r requirements.txt
|
|||
### Run It!
|
||||
|
||||
```
|
||||
GH_USER=<Github username> GH_PASS=<Github password> fab parse_projects
|
||||
GH_USER=<Github Username> GH_PASS=<Github Password> fab parse_projects
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
GH_USER=<Github username> GH_PASS=<Github password> ./update.sh .
|
||||
GH_USER=<Github Username> GH_PASS=<Github Password> ./update.sh <path-to-project-repo>
|
||||
```
|
||||
|
||||
Both the above scripts will clone all the projects in `repos.txt` and try to
|
||||
|
@ -30,5 +37,25 @@ using Github Pages.
|
|||
|
||||
### Cron Setup
|
||||
|
||||
THe ideal setup would be to have the above scripts run using `crontab`. Setup
|
||||
THe ideal setup would be to have the above scripts run via `crontab`. Setup
|
||||
a cronjob to run the above scripts so that they get executred periodically.
|
||||
Something like:
|
||||
|
||||
```
|
||||
*/30 * * * * pushd <path to mozwebqa-dashboard> && GH_USER=<Github Username> GH_PASS=<Github Password> fab parse_projects && popd
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
*/30 * * * * pushd <path to mozwebqa-dashboard> && GH_USER=<Github Username> GH_PASS=<Github Password> ./update.sh . && popd
|
||||
|
||||
# or
|
||||
|
||||
*/30 * * * * GH_USER=<Github Username> GH_PASS=<Github Password> <path to mozwebqa-dashboard>/update.sh <path to mozwebqa-dashboard>
|
||||
```
|
||||
|
||||
### Adding More Projects
|
||||
|
||||
To add a new project to track, add the project's Github repository URL in a
|
||||
new line in `repos.txt`.
|
||||
|
|
Загрузка…
Ссылка в новой задаче