Skip to content

Commit 741ec00

Browse files
authored
Update README.md
1 parent 1f4e2ee commit 741ec00

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,33 @@ Sync GitHub repositories into InterSystems Cache.
44
Installation
55
-----------
66

7-
1. Download Task.cls.xml and import it into Caché (any namespace, further referred to as {Namespace}).
7+
1. Download the latest Release .xml file and import it into Caché (any namespace, further referred to as {Namespace}).
88

99
Usage
1010
-----------
1111

12-
To create task for syncing GitHub repository → Cache instance do the following:
12+
Call
13+
14+
w ##class(CacheUpdater.Task).Update("Owner", "Repository", "Branch", "Username", "Password", "Namespace")
15+
16+
to download and compile classes from the Github repo.
17+
18+
Where
19+
<b>Owner</b> - The name of the repository owner.<br>
20+
<b>Repository</b> - The name of the repository.<br>
21+
<b>Branch</b> - The name of the commit/branch/tag. If skipped the repository’s default branch (usually master) would be used.<br>
22+
<b>Username</b> - GitHub user, who has access to repository. Optional for public repositories.<br>
23+
<b>Password</b> - GitHub password, corresponding to Username. Optional for public repositories.<br>
24+
Note, that with Username, you can make up to 5,000 requests per hour.
25+
For unauthenticated requests, the rate limit allows to make up to 60 requests per hour.
26+
Unauthenticated requests are associated with an IP address.<br>
27+
<b>Namespace</b> - Namespace, where to download and compile repository.<br>
28+
For example in the repository: https://github.com/intersystems-ru/Cache-MDX2JSON<br>
29+
Owner - intersystems-ru, Repository - Cache-MDX2JSON.<br>
30+
31+
OR
32+
33+
create task for syncing GitHub repository → Cache instance do the following:
1334

1435
1. Go to SMP → System Operation → Task Manager → New Task
1536
2. Set <i>Name</i> as desired
@@ -24,10 +45,6 @@ To create task for syncing GitHub repository → Cache instance do the followin
2445
After task runs at least once you will get <i>GitHubURL</i> repository contents in <i>Namespace</i>
2546

2647

27-
Note that in order to sync CLS, MAC, INT, INC and DFI files they need to be stored<br>
28-
at corresponding folders. For example: <br>
29-
<b>for CLS</b>: cls/packagename/file.cls<br>
30-
<b>for MAC</b>: mac/file.mac
3148

3249
Continuous Integration
3350
-----------

0 commit comments

Comments
 (0)