https://github.com/evref-bl/verveinej-docker

https://github.com/evref-bl/verveinej-docker

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/evref-bl/verveinej-docker
• Owner: Evref-BL
• Created: 2022-08-09T08:55:37.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-12T15:27:14.000Z (about 2 months ago)
• Last Synced: 2024-11-12T16:33:10.510Z (about 2 months ago)
• Language: Dockerfile
• Size: 73.2 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# VerveineJ Dockerfile

This docker file configures VerveineJ to be used with the local system

It automatically uses VerveineJ with the good Java version.

## Releases 

| tag name | release |

| :---: | :---: |

| `main` | Last release of this docker with latest VerveineJ |

| `latest` | Latest VerveineJ release (potentially not with latest docker option) |

| `vX.X.X` | Follow [VerveineJ releases](https://github.com/moosetechnology/VerveineJ) |

## Command line

To run this docker, first, separate the sources and the dependency into two different folders.

Then execute the following command:

```sh

docker pull ghcr.io/evref-bl/verveinej:latest

docker run -v :/src [-v :/dependency] ghcr.io/evref-bl/verveinej:latest 

```

> Note1: The option `-v :/dependency` binds (or mounts) a directory on the host computer to the `dependency` directory in the docker virtual machine.

> VerveineJ-Docker automatically uses this repository

> Note2: Similarly `-v :/src` (`-v` for `-volume`) binds a directory on the host computer to the `src` directory in the docker virtual machine.

> VerveineJ in the docker image runs inside this `src` directory. Therefore, it parses any Java file in `src`.

### Example

Basic example using docker desktop

```sh

docker run --rm -v D:\Users\benoit.verhaeghe\Documents\git\badetitou\Carrefour\testing\src\:/src ghcr.io/evref-bl/verveinej:latest -format json -o testoutput.json

```

Another example with docker in Window **without** docker desktop but with docker in wsl2 (see [this blog post](https://dev.to/_nicolas_louis_/how-to-run-docker-on-windows-without-docker-desktop-hik))

```sh

docker run --rm -v "/mnt/d/Developpement/git/evol-critics:/src" ghcr.io/evref-bl/verveinej:latest -Xmx16g -- -format json -alllocals -anchor assoc -o output.json

```

## GitLab example

```yml

parse:

  stage: parse

  image:     

    name: ghcr.io/evref-bl/verveinej:v3.2.1

    entrypoint: [""]

  needs:

  script:

    - /VerveineJ-3.2.1/verveinej.sh -format json -o model.json -alllocals -anchor assoc -autocp ./repo ./src

  artifacts:

    paths:

      - model.json

  only:

  - ci-backend

```

## GitHub example

Use the VerveineJ docker image in a GitHub action (example for version `v3.2.1`)

```yml

name: My CI

on:

  push:

    branches: [ main ]

jobs:

  build:

    runs-on: ubuntu-latest

    strategy:

      fail-fast: false

      matrix:

        smalltalk: [  Moose64-10 ]

    name: ${{ matrix.smalltalk }}

    steps:

      - uses: actions/checkout@v3

        with:

          fetch-depth: '0'

      - uses: addnab/docker-run-action@v3

        with:

          registry: ghcr.io

          image:  ghcr.io/evref-bl/verveinej:v3.2.1

          options: -v ${{ github.workspace }}:/src

          run: |

            cd tests

            /VerveineJ-3.2.1/verveinej.sh -format json -o output.json -alllocals -anchor assoc .

            cd ..

```