Skip to content

Commit eecb43d

Browse files
committed
docs
1 parent 61c89b1 commit eecb43d

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
# GitHubUpdater
2-
Sync GitHub repositories into InterSystems Cache
2+
Sync GitHub repositories into InterSystems Cache.
3+
4+
Installation
5+
-----------
6+
7+
1. Download Task.cls.xml and import it into Caché (any namespace, further referred to as {Namespace}).
8+
9+
Usage
10+
-----------
11+
12+
To create task for syncing GitHub repository → Cache instance do the following:
13+
14+
1. Go to SMP → System Operation → Task Manager → New Task
15+
2. Set <i>Name</i> as desired
16+
3. Set <i>Namespace to run task in</i> to {Namespace}
17+
4. Set <i>Task type</i> to GitHub Update
18+
5. Set <i>GitHubURL</i> to a valid GitHub repository, eg: https://github.com/intersystems-ru/Cache-MDX2JSON
19+
7. Set <i>Namespace</i> to a Namespace you want to download GitHub repository to
20+
8. Optionally provide <i>Username</i>, <i>Password</i> (for private repos or very frequent updates).
21+
9. Set up the <i>Branch</i> you need. Possible values are - commit/branch/tag
22+
8. Set other parameters as desired and finish creation of the task
23+
24+
After task runs at least once you will get <i>GitHubURL</i> repository contents in <i>Namespace</i>
25+
26+
Continuous Integration
27+
-----------
28+
29+
If you want more functionality check out [CacheGitHubCI](https://github.com/intersystems-ru/CacheGitHubCI) project.

0 commit comments

Comments
 (0)