Skip to content

Commit

Permalink
ci: Update Docker workflow to remove main branch trigger and adjust R…
Browse files Browse the repository at this point in the history
…EADME for Docker usage
  • Loading branch information
Ziaeemehr committed Feb 24, 2025
1 parent fc2c9a3 commit 79e4fd9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docker-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ name: build & push Docker image to ghcr

on:
push:
branches:
- main # Runs when pushing to develop branch
# branches:
# - main # Runs when pushing to develop branch
tags:
- v* # Runs when pushing tags starting with 'v'

Expand Down
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,19 @@
To use the Docker image, you can pull it from the GitHub Container Registry and run it as follows:

```bash
# Get it without building anything locally
# without GPU
docker run --rm -it ghcr.io/ins-amu/vbi:main

# with GPU
docker run --gpus all --rm -it ghcr.io/ins-amu/vbi:main


# or build it locally:
docker build -t vbi-project . # build
docker run --gpus all -it vbi-project # use with gpu

# Output something like this:
# Output is expected to be something like this:

Dependency Check

Expand All @@ -54,6 +63,9 @@ To use the Docker image, you can pull it from the GitHub Container Registry and
Total Memory: 23.68 GB
Compute Capability: 8.6

```


```


Expand Down

0 comments on commit 79e4fd9

Please sign in to comment.