Skip to content

Commit

Permalink
chore: add clarifications to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Updated the instructions to clarify the use of venv
  • Loading branch information
mgyorke committed Apr 16, 2024
1 parent e0ea1d8 commit 66d97b0
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -17,7 +17,7 @@ Clone this repository with git.

```sh
git clone git@github.com/snyk/cli.git
cd snyk
cd cli
```

You will now be on our `main` branch. You should never commit to this branch, but you should keep it up-to-date to ensure you have the latest changes.
Expand All @@ -35,16 +35,25 @@ make clean

## Building

To build the project, run the following command in the root of the repository.
To build the project, run the following commands in the root of the repository.

The _install-dev-dependencies.sh_ script created a venv with the necessary dependencies, we need to activate it:

```sh
source .venv/bin/activate
```

Now we trigger the build process:

```sh
make build
```

Run the build binary like this.
Run the build binary like this, depending on your architecture:

```sh
./binary-releases/snyk-macos --version
./binary-releases/snyk-macos-arm64 --version
```

## Running tests
Expand Down Expand Up @@ -116,6 +125,14 @@ You can run acceptance tests with:
npm run test:acceptance -- --selectProjects coreCli
```

The output is saved as _junit.xml_ inside the root folder.

Another example, if we want the output in console and to run a single test suite by name:

```
npm run test:acceptance -- --selectProjects coreCli --reporters=default -t 'woof'
```

### Smoke Tests

Smoke tests typically don't run on branches unless the branch is specifically prefixed with `smoke/`. They usually run on an hourly basis against the latest published version of the CLI.
Expand Down

0 comments on commit 66d97b0

Please sign in to comment.