Skip to content

Commit d360c93

Browse files
ometelytsiadoit-bi-do
authored andcommitted
Docs updates for bamboo generator (atlassian#749)
1 parent ee1b230 commit d360c93

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

app/util/bamboo/bamboo_dataset_generator/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Configuration located inside: [src/main/java/bamboogenerator/Main.java](src/main
1010
- `ADMIN_USER_NAME` - the username of admin account
1111

1212

13-
**Generator Configuration**
13+
**Generator Configuration**
1414
- `PROJECTS_NUMBER` - the number of projects to generate
1515
- `PLANS` - the number of plans to generate
1616
- `PERCENT_OF_FAILED_PLANS` - the percent of plans to be generated as failed
@@ -26,14 +26,17 @@ The generator will check if you have plans on a Bamboo server that are out of th
2626
it will fail execution if such plans exist.
2727

2828
---
29+
**Generate Bamboo token**
30+
31+
Login as admin user, go to **Profile > Personal access tokens** and create a new token with the same
32+
permissions as admin user.
2933

3034
**Run on Linux/Mac:**
3135

36+
export BAMBOO_TOKEN=newly_generarted_token
3237
./run.sh
3338

3439
**Run on Windows:**
35-
36-
run
37-
38-
3940

41+
set BAMBOO_TOKEN=newly_generarted_token
42+
run

docs/dc-apps-performance-toolkit-user-guide-bamboo.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,7 @@ your app. For example, application setup screen or other one-time use cases are
263263
If your app introduces new functionality for Bamboo entities, for example new task, it is important to extend base
264264
dataset with your app specific functionality.
265265

266+
1. Follow installation instructions described in [bamboo dataset generator README.md](https://raw.githubusercontent.com/atlassian/dc-app-performance-toolkit/master/app/util/bamboo/bamboo_dataset_generator/README.md)
266267
1. Open `app/util/bamboo/bamboo_dataset_generator/src/main/java/bamboogenerator/Main.java` and set:
267268
- `BAMBOO_SERVER_URL`: url of Bamboo stack
268269
- `ADMIN_USER_NAME`: username of admin user (default is `admin`)
@@ -274,7 +275,7 @@ permissions as admin user.
274275
```
275276
or
276277
``` bash
277-
set BAMBOO_TOKEN newly_generarted_token # for Windows
278+
set BAMBOO_TOKEN=newly_generarted_token # for Windows
278279
```
279280
1. Open `app/util/bamboo/bamboo_dataset_generator/src/main/java/bamboogenerator/service/generator/plan/PlanGenerator.java`
280281
file and modify plan template according to your app. e.g. add new task.

0 commit comments

Comments
 (0)