Skip to content

Commit

Permalink
Add example of services option
Browse files Browse the repository at this point in the history
  • Loading branch information
jennydaman committed Jul 27, 2024
1 parent 111618c commit a0d0a68
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,26 @@ jobs:
ghcr.io/fnndsc/pl-re-sub:1.1.1
```

### Optimization

Suppose you want to run a test which needs the _CUBE_ server, database, and oxidicom, but you don't need to be able to run plugins.
You can omit the workers and pfcon from startup, which can improve startup speeds and reduce memory usage.

```yaml
on: [push]
jobs:
hello_world_job:
runs-on: ubuntu-latest
name: Do nothing useful
steps:
- name: setup CUBE
id: cube
uses: FNNDSC/miniChRIS-docker@master
with:
services: chris oxidicom
```

### Examples

- [FNNDSC/ChRIS_ui/.github/workflows/tests.yml](https://github.com/FNNDSC/ChRIS_ui/blob/0b7e4c5c5ae9dec9c44ea68db85373d2df403b64/.github/workflows/tests.yml#L21-L27) uses _miniChRIS_ for testing using [Cypress](https://cypress.io)
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ services:
condition: service_healthy
networks:
- local

chris:
container_name: chris
image: ghcr.io/fnndsc/cube:5.0.0
Expand Down

0 comments on commit a0d0a68

Please sign in to comment.