Skip to content

Commit 5b1e3d9

Browse files
authored
Modified function
1 parent a468e01 commit 5b1e3d9

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

documentation/Functions.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -625,19 +625,21 @@ This function only consist of one parameter.
625625
- **Description**- Name of the workspace repository(Default is the playbook-name).
626626

627627
#### Arguments:
628-
**User**(Optional)
629-
flag: --user
630-
value: GitHub-username (Default is 'devonfw-tutorials')
628+
* **User**
629+
- (Optional)
630+
- flag: --user
631+
- value: GitHub-username (Default is 'devonfw-tutorials')
631632

632-
You can use a forked workspace-repository, if you add the username as argument. If the runner cannot find the workspace repository in the your repositories, it will use devonfw-tutorials instead.
633+
Note: You can use a forked workspace-repository, if you add the username as argument. If the runner cannot find the workspace repository in the your repositories, it will use devonfw-tutorials instead.
633634

634-
**Branch**(Optional)
635-
flag: --branch
636-
value: the working branch (Default is its default-branch)
635+
* **Branch**
636+
- (Optional)
637+
- flag: --branch
638+
- value: the working branch (Default is its default-branch)
637639

638-
You can use a different branch, if you add the working branch as argument. If the runner cannot find the branch in the cloned repository, it will use the default branch instead.
640+
Note: You can use a different branch, if you add the working branch as argument. If the runner cannot find the branch in the cloned repository, it will use the default branch instead.
639641

640-
buildRun.sh --user [username] --branch [branch]
642+
* buildRun.sh --user [username] --branch [branch]
641643

642644
#### Example:
643645

@@ -647,8 +649,8 @@ will clone "https://github.com/devonfw-tutorials/[playbook-name]" into the works
647649
* restoreWorkspace({"workspace": [name]})
648650
will clone "https://github.com/devonfw-tutorials/[name]" into the workspace directory.
649651

650-
**buildRun.sh --user [GitHub-name] --branch [branch]**
651-
* restoreWorkspace()
652+
* **buildRun.sh --user [GitHub-name] --branch [branch]**
653+
restoreWorkspace()
652654
will run "git clone https://github.com/[GitHub-name]/[playbook-name]" and checkout in branch [branch]
653655

654656
#### details

0 commit comments

Comments
 (0)