Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: snyk/cli
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v1.981.0
Choose a base ref
...
head repository: snyk/cli
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v1.982.0
Choose a head ref
  • 20 commits
  • 20 files changed
  • 8 contributors

Commits on Jul 25, 2022

  1. Verified

    This commit was signed with the committer’s verified signature.
    francescomari Francesco Mari
    Copy the full SHA
    6fb5992 View commit details

Commits on Jul 26, 2022

  1. docs: update contributing readme

    Mention conventional commits and swap word customer to user
    JackuB authored Jul 26, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    656e727 View commit details
  2. docs: synchronizing help from snyk/user-docs

    Signed-off-by: Jakub Mikulas <jakub@snyk.io>
    JackuB committed Jul 26, 2022

    Verified

    This commit was signed with the committer’s verified signature.
    JackuB Jakub Mikulas
    Copy the full SHA
    eb95314 View commit details
  3. Merge pull request #3475 from snyk/docs/automatic-gitbook-update

    Synchronizing CLI help from user-docs
    JackuB authored Jul 26, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    74f3207 View commit details
  4. Merge pull request #3490 from snyk/docs/contributing-conventional-com…

    …mits
    
    Update contributing readme
    JackuB authored Jul 26, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    35db5b8 View commit details
  5. Verified

    This commit was signed with the committer’s verified signature.
    ofekatr Ofek A
    Copy the full SHA
    eb5719e View commit details
  6. Merge pull request #3484 from snyk/feat/iac-test-v2-pass-config

    feat: pass configuration to snyk-iac-test
    francescomari authored Jul 26, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    6245e43 View commit details

Commits on Jul 27, 2022

  1. Merge pull request #3485 from snyk/chore/add-errors-to-results-cfg-2036

    chore: Add errors to results for JSON output [CFG-2036]
    ofekatr authored Jul 27, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    204d5f5 View commit details
  2. Verified

    This commit was signed with the committer’s verified signature.
    ofekatr Ofek A
    Copy the full SHA
    66803e0 View commit details
  3. Merge pull request #3497 from snyk/chore/add-cwd-to-error-message

    chore: Added CWD path to out of CWD error message
    ofekatr authored Jul 27, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    53bb090 View commit details

Commits on Jul 28, 2022

  1. Verified

    This commit was signed with the committer’s verified signature.
    ofekatr Ofek A
    Copy the full SHA
    99b8ee0 View commit details
  2. Merge pull request #3501 from snyk/fix/fix-iac-test-exit-code

    chore: Fix IaC test exit code when issues are found
    ofekatr authored Jul 28, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    f83eaf9 View commit details
  3. Unverified

    This user has not yet uploaded their public signing key.
    Copy the full SHA
    a59d8e4 View commit details
  4. Merge pull request #3507 from snyk/fix/upgrade-docker-plugin

    fix: upgrade docker plugin to improve stream parsing
    ivanstanev authored Jul 28, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    370ad1e View commit details

Commits on Jul 29, 2022

  1. Verified

    This commit was signed with the committer’s verified signature.
    francescomari Francesco Mari
    Copy the full SHA
    8f05a21 View commit details
  2. Merge pull request #3508 from snyk/chore/upgrade-snyk-iac-test

    chore: upgrade snyk-iac-test to v0.11.0
    francescomari authored Jul 29, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    27db3a3 View commit details

Commits on Jul 31, 2022

  1. Verified

    This commit was signed with the committer’s verified signature.
    ofekatr Ofek A
    Copy the full SHA
    f66ee0d View commit details

Commits on Aug 1, 2022

  1. Merge pull request #3492 from snyk/chore/add-tests-for-test-json-output

    chore: Added tests for IaC JSON test output
    ofekatr authored Aug 1, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    3016a01 View commit details

Commits on Aug 2, 2022

  1. feat: upgrade snyk iac test to 0.13.1

    Ilianna Papastefanou committed Aug 2, 2022

    Unverified

    No user is associated with the committer email.
    Copy the full SHA
    ce7103e View commit details
  2. Merge pull request #3514 from snyk/feat/upgrade-snyk-iac-test

    feat: upgrade snyk iac test to 0.13.1
    ipapast authored Aug 2, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    513ec4a View commit details
16 changes: 10 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -107,7 +107,7 @@ If you are mostly testing functions calling other functions, consider writing an

### Acceptance tests

Acceptance tests enforce the correctness of our distribution and are written from the perspective of a customer.
Acceptance tests enforce the correctness of our distribution and are written from the perspective of an user.

Snyk CLI's acceptance tests execute a specific command line as a standalone process, then assert on `stdout`, `stdin` and the exit code. As an example, see: [`oauth-token.spec.ts`](test/jest/acceptance/oauth-token.spec.ts).

@@ -162,7 +162,7 @@ You will need to fix any remaining issues manually.

When making changes, ensure documentation is updated accordingly.

Customer-facing documentation is [available on GitBook](https://docs.snyk.io/features/snyk-cli).
User-facing documentation is [available on GitBook](https://docs.snyk.io/features/snyk-cli).

`snyk help` output must also be [edited on GitBook](https://docs.snyk.io/features/snyk-cli/commands). Changes will automatically be pulled into Snyk CLI as pull requests.

@@ -199,9 +199,7 @@ Each commit must provide some benefit on its own without breaking the release pi

For larger changes, break down each step into multiple commits so that it's easy to review in pull requests and git history.

Your changes must be backwards compatible and cannot break existing customer pipelines.

Commits must follow this structure:
Commits must follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) structure:

```
type: summary of your changes
@@ -217,13 +215,19 @@ docs: update contributing guide
We often get questions on how to contribute to this repo. What versions to use, what the workflow is, and so on. This change updates our CONTRIBUTING guide to answer those types of questions.
```

### No breaking changes

Your changes must be backwards compatible and cannot break existing user pipelines.

Don't use `BREAKING CHANGE` or exclamation mark `!` from the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

### Commit types

The commit type is used to summarize intent and to automate various steps.

| Type | Description |
| ---------- | ----------------------------------------------- |
| `feat` | A new customer-facing feature. |
| `feat` | A new user-facing feature. |
| `fix` | A bug fix for an existing feature. |
| `refactor` | Changes which do not affect existing features. |
| `test` | Changes to tests for existing features. |
26 changes: 1 addition & 25 deletions help/cli-commands/monitor.md
Original file line number Diff line number Diff line change
@@ -168,7 +168,7 @@ Set the project tags to one or more values (comma-separated key value pairs with

This is an alias for `--project-tags`

## Options for Maven projects
## Option for Maven projects

For more information about Maven CLI options see [Snyk for Java and Kotlin](https://docs.snyk.io/products/snyk-open-source/language-and-package-manager-support/snyk-for-java-gradle-maven)

@@ -178,20 +178,6 @@ Auto-detect maven jars, aars, and wars in given directory. To monitor individual

**Note**: Custom-built jar files, even with open source dependencies, are out of scope.

### `--reachable`

WARNING: Will be removed on 15 August 2022

Analyze your source code to find which vulnerable functions and packages are called. Cannot be used with `--all-projects`

### `--reachable-timeout=<TIMEOUT>`

WARNING: Will be removed on 15 August 2022

Specify the amount of time (in seconds) to wait for Snyk to gather reachability data. If it takes longer than `<TIMEOUT>`, reachable vulnerabilities are not reported. This does not affect regular test or monitor output.

Default: 300 (5 minutes).

## Options for Gradle projects

For more information about Gradle CLI options see [Snyk for Java and Kotlin](https://docs.snyk.io/products/snyk-open-source/language-and-package-manager-support/snyk-for-java-gradle-maven)
@@ -216,16 +202,6 @@ Select certain values of configuration attributes to install dependencies and pe

Example: `buildtype:release,usage:java-runtime`

### `--reachable`

Analyze your source code to find which vulnerable functions and packages are called.

### `--reachable-timeout=<TIMEOUT>`

Specify the amount of time (in seconds) to wait for Snyk to gather reachability data. If it takes longer than `<TIMEOUT>`, reachable vulnerabilities are not reported. This does not affect regular test or monitor output.

Default: 300 (5 minutes).

### `--init-script=<FILE`

Use for projects that contain a Gradle initialization script.
26 changes: 1 addition & 25 deletions help/cli-commands/test.md
Original file line number Diff line number Diff line change
@@ -173,7 +173,7 @@ Fail only when there are vulnerabilities that can be fixed.

To fail on any vulnerability (the default behavior), do not use the `--fail-on` option. If vulnerabilities do not have a fix and this option is being used, tests pass.

## Options for Maven projects
## Option for Maven projects

For more information about Maven CLI options see [Snyk for Java and Kotlin](https://docs.snyk.io/products/snyk-open-source/language-and-package-manager-support/snyk-for-java-gradle-maven)

@@ -183,20 +183,6 @@ Auto-detect maven jars, aars, and wars in given directory. To test individually

**Note**: Custom-built jar files, even with open source dependencies, are out of scope.

### `--reachable`

WARNING: Will be removed on 15 August 2022

Analyze your source code to find which vulnerable functions and packages are called. Cannot be used with `--all-projects`

### `--reachable-timeout=<TIMEOUT>`

WARNING: Will be removed on 15 August 2022

Specify the amount of time (in seconds) to wait for Snyk to gather reachability data. If it takes longer than `<TIMEOUT>`, reachable vulnerabilities are not reported. This does not affect regular test or monitor output.

Default: 300 (5 minutes).

## Options for Gradle projects

For more information about Gradle CLI options see [Snyk for Java and Kotlin](https://docs.snyk.io/products/snyk-open-source/language-and-package-manager-support/snyk-for-java-gradle-maven)
@@ -221,16 +207,6 @@ Select certain values of configuration attributes to install dependencies and pe

Example: `buildtype:release,usage:java-runtime`

### `--reachable`

Analyze your source code to find which vulnerable functions and packages are called.

### `--reachable-timeout=<TIMEOUT>`

Specify the amount of time (in seconds) to wait for Snyk to gather reachability data. If it takes longer than `<TIMEOUT>`, reachable vulnerabilities are not reported. This does not affect regular test or monitor output.

Default: 300 (5 minutes).

### `--init-script=<FILE`

Use for projects that contain a Gradle initialization script.
Loading