Skip to content

Commit 597560a

Browse files
author
Jennings Zhang
committed
Rename to miniChRIS
1 parent 16517ed commit 597560a

File tree

7 files changed

+24
-24
lines changed

7 files changed

+24
-24
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# ![ChRIS logo](https://raw.githubusercontent.com/FNNDSC/ChRIS_ultron_backEnd/master/docs/assets/logo_chris.png) _ChRIS_ Minimake
1+
# ![ChRIS logo](https://raw.githubusercontent.com/FNNDSC/ChRIS_ultron_backEnd/master/docs/assets/logo_chris.png) miniChRIS
22

3-
[![CI](https://github.com/FNNDSC/minimake/workflows/CI/badge.svg)](https://github.com/FNNDSC/minimake/actions?query=workflow%3ACI)
4-
[![GitHub license](https://img.shields.io/github/license/FNNDSC/minimake)](https://github.com/FNNDSC/minimake/blob/master/LICENSE)
3+
[![CI](https://github.com/FNNDSC/miniChRIS/workflows/CI/badge.svg)](https://github.com/FNNDSC/miniChRIS/actions?query=workflow%3ACI)
4+
[![GitHub license](https://img.shields.io/github/license/FNNDSC/miniChRIS)](https://github.com/FNNDSC/miniChRIS/blob/master/LICENSE)
55

66
Run a demo of ChRIS. https://chrisproject.org/
77

88
```bash
9-
git clone https://github.com/FNNDSC/minimake.git chris_minimake
10-
cd chris_minimake
11-
./minimake.sh
9+
git clone https://github.com/FNNDSC/miniChRIS.git
10+
cd miniChRIS
11+
./minichris.sh
1212
```
1313

1414
## Usage
@@ -52,7 +52,7 @@ docker wait cube-setup
5252
Beautiful output and some runtime assertions.
5353

5454
```bash
55-
./minimake.sh
55+
./minichris.sh
5656
```
5757

5858
### Add Plugins
@@ -71,11 +71,11 @@ docker exec chris python plugins/services/manager.py register host --pluginurl "
7171
docker pull $dock_image
7272
```
7373

74-
For more examples, see https://github.com/FNNDSC/minimake/wiki/Add-Plugins
74+
For more examples, see https://github.com/FNNDSC/miniChRIS/wiki/Add-Plugins
7575

7676
# Github Actions
7777

78-
*Minimake* can be used as a step in Github Actions workflows to spin up
78+
*miniChRIS* can be used as a step in Github Actions workflows to spin up
7979
an ephermeral instance of the ChRIS backend and its ancillary services
8080
for the purpose of end-to-end testing.
8181

@@ -89,20 +89,20 @@ jobs:
8989
steps:
9090
- name: setup CUBE
9191
id: cube
92-
uses: fnndsc/minimake@v3
92+
uses: fnndsc/miniChRIS@v3
9393
- name: make a request
9494
run: curl -u "${{ steps.cube.outputs.cube-user }}" "${{ steps.cube.outputs.cube-url }}"
9595
```
9696
9797
### Examples
9898
99-
- [FNNDSC/cookicutter-chrisapp/.github/workflows/test.yml](https://github.com/FNNDSC/cookiecutter-chrisapp/blob/16db74860e8201f3d201183961eadc39116ce8a7/.github/workflows/test.yml#L31) uses *ChRIS Minimake* for end-to-end testing.
100-
- [FNNDSC/cni-store-proxy/package.json](https://github.com/FNNDSC/cni-store-proxy/blob/master/package.json) uses *ChRIS Minimake* as a git submodule for a local dev environment.
99+
- [FNNDSC/cookicutter-chrisapp/.github/workflows/test.yml](https://github.com/FNNDSC/cookiecutter-chrisapp/blob/16db74860e8201f3d201183961eadc39116ce8a7/.github/workflows/test.yml#L31) uses *ChRIS miniChRIS* for end-to-end testing.
100+
- [FNNDSC/cni-store-proxy/package.json](https://github.com/FNNDSC/cni-store-proxy/blob/master/package.json) uses *ChRIS miniChRIS* as a git submodule for a local dev environment.
101101
102102
103103
# About
104104
105-
`./minimake.sh` is a no-nonsense collection of scripts to start ChRIS without the shenanigans of
105+
`./minichris.sh` is a no-nonsense collection of scripts to start ChRIS without the shenanigans of
106106
[make.sh](https://github.com/FNNDSC/ChRIS_ultron_backEnd/blob/master/make.sh).
107107
It is fully managed by `docker-compose`.
108108

@@ -128,8 +128,8 @@ We can resolve the two setup requirements by connecting to the host's dockerd.
128128
The workaround for `STOREBASE` was merged upstream.
129129
https://github.com/FNNDSC/pman/pull/142
130130

131-
`./minimake.sh` takes 50 seconds on an okay laptop (quad-core, 16 GB, SSD)
132-
and takes 2-3 minutes in [Github Actions' Ubuntu VMs](https://github.com/FNNDSC/minimake/actions).
131+
`./minichris.sh` takes 50 seconds on an okay laptop (quad-core, 16 GB, SSD)
132+
and takes 2-3 minutes in [Github Actions' Ubuntu VMs](https://github.com/FNNDSC/miniChRIS/actions).
133133

134134
### Goals
135135

Vagrantfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ Vagrant.configure("2") do |config|
2121
systemctl enable --now docker
2222
SHELL
2323

24-
config.vm.provision "shell", run: "always", inline: "cd /vagrant && ./minimake.sh"
24+
config.vm.provision "shell", run: "always", inline: "cd /vagrant && ./minichris.sh"
2525
end

docker-compose.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ services:
140140
image: fnndsc/pman:3.1.0-rc.1
141141
container_name: pman
142142
environment:
143-
PMAN_DOCKER_VOLUME: chris-minimake-pfioh-remote
143+
PMAN_DOCKER_VOLUME: minichris-pfioh-remote
144144
CONTAINER_ENV: swarm
145145
SECRET_KEY: secret
146146
volumes:
@@ -209,4 +209,4 @@ networks:
209209

210210
volumes:
211211
pfioh-remote:
212-
name: chris-minimake-pfioh-remote
212+
name: minichris-pfioh-remote
File renamed without changes.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
{
2-
"name": "minimake",
2+
"name": "minichris",
33
"version": "1.0.0",
44
"description": "Github action for ChRIS backend services",
55
"author": "FNNDSC <[email protected]>",
66
"license": "MIT",
77
"main": "wrapper.js",
88
"repository": {
99
"type": "git",
10-
"url": "git+https://github.com/FNNDSC/minimake.git"
10+
"url": "git+https://github.com/FNNDSC/miniChRIS.git"
1111
},
12-
"homepage": "https://github.com/FNNDSC/minimake#readme",
12+
"homepage": "https://github.com/FNNDSC/miniChRIS#readme",
1313
"bugs": {
14-
"url": "https://github.com/FNNDSC/minimake/issues"
14+
"url": "https://github.com/FNNDSC/miniChRIS/issues"
1515
}
1616
}

provision/setup.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ fi
1414
docker exec chris python manage.py shell -c '
1515
from core.models import ChrisInstance
1616
inst = ChrisInstance.load()
17-
inst.job_id_prefix = "chris-minimake-jid-"
17+
inst.job_id_prefix = "minichris-jid-"
1818
inst.save()'
1919

2020

wrapper.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const { execFileSync } = require('child_process');
88
const path = require('path');
99
const isPost = !!process.env['STATE_isPost'];
1010

11-
const script = path.join(__dirname, isPost ? 'unmake.sh' : 'minimake.sh');
11+
const script = path.join(__dirname, isPost ? 'unmake.sh' : 'minichris.sh');
1212
execFileSync(script, { stdio: 'inherit' });
1313

1414
if (!isPost) {

0 commit comments

Comments
 (0)