feat(cli): Add available version checking #8553

owenrumney · 2025-03-14T11:07:27Z

Description

Adds a background check to https://api.trivy.cloud/check to see if there is new version or any relevant notices available.

The check will be suppressed if the user uses the --no-notices or --quiet envvars or flags. The docs have been updated with the new notices flag

Example output

Although the image shows dummy versions, the api has been updated to reflect the correct information and has no announcements at this time... just the latest version (0.60.0)

Related issues

Checklist

I've read the guidelines for contributing to this repository.
I've followed the conventions in the PR title.
I've added tests that prove my fix is effective or that my feature works.
I've updated the documentation with the relevant information (if needed).
I've added usage information (if the PR introduces new options)
I've included a "before" and "after" example to the description (if the PR is a user interface change).

DmitriyLewen

@owenrumney left comments.
Take a look, please.

Also I think update is not a very good name for this logic.
Maybe something like notification?

UPD:
and I would also think about how we can inform users about the ---no-notises flag

pkg/commands/app.go

docs/docs/references/configuration/cli/trivy_clean.md

pkg/update/check.go

pkg/commands/artifact/run.go

knqyf263

LGTM. I left small comments.

pkg/notification/notice.go

pkg/commands/artifact/run.go

knqyf263

I think we also need to create a new page for privacy. @itaysk should know some examples from other OSS projects.

pkg/notification/notice.go

knqyf263 · 2025-04-17T16:42:37Z

pkg/notification/notice.go

+		if !v.skipUpdateCheck && !v.quiet {
+			v.responseReceived = true
+		}
+		v.done = true


Where is this used?

It's actually only used in the test at the moment to know when the process is completed

pkg/notification/notice.go

itaysk · 2025-04-18T09:00:39Z

I think we also need to create a new page for privacy. @itaysk should know some examples from other OSS projects.

yes I already have a draft for a dedicated doc, wasn't sure if we want it in the same PR or not. actually I'll try to add it to this one. (ps i don't think the doc should include referenences from other products)

pkg/flag/scan_flags.go

knqyf263

LGTM!

I'm fine with updating the documentation either in this PR or in a separate one, as long as it gets updated before the next release—so I'll approve this PR.

pkg/notification/option.go

nikpivkin

LGTM. Left a small comment

itaysk · 2025-04-19T08:25:06Z

I may have some more comment after writing the doc, so don't merge it yet please

helm/trivy/Chart.yaml

DmitriyLewen

LGTM
left small comments

pkg/notification/notice.go

DmitriyLewen

LGTM
left small comments

- Update the preRun and postRun to check and print the latest version - Run in a go routine so as not to interfere or slow the normal flow - Provide new `--no-notices` flag to prevent notice checking, same if they `-q/--quiet` flag is used - Add tests for the identifier and the check logic

- change no-notices flag to `skip-version-check` and add `disable-metrics` flag - create VersionChecker type and add to runner - if the flag conditions are met, create a new checker and trigger check - handle logic of flags for disabling metrics - update the tests

Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

Co-authored-by: Teppei Fukuda <knqyf263@gmail.com>

Remove the -x prefix as per RFC6648. While headers are case-insensitve, making custom headers title case as per general convention. Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

- update the URL to check.trivy.cloud/updates - change the flag to disable-telemetry - update tests Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

offline scan isn't to be included at the moment, this will be tackled as a different piece of work. tidied up the notices option to be more consistent with the flag it reflects Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

…ents Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

- add support for different formats of date time from the service Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

docs/docs/advanced/telemetry.md

simar7

lgtm, left a small comment.

Co-authored-by: simar7 <1254783+simar7@users.noreply.github.com>

DmitriyLewen

LGTM

knqyf263 · 2025-05-26T10:38:19Z

@itaysk Can we merge this PR?

owenrumney self-assigned this Mar 14, 2025

owenrumney marked this pull request as ready for review March 14, 2025 11:44

owenrumney requested a review from knqyf263 as a code owner March 14, 2025 11:44

knqyf263 requested a review from DmitriyLewen March 17, 2025 02:44

DmitriyLewen reviewed Mar 17, 2025

View reviewed changes

owenrumney marked this pull request as draft March 17, 2025 11:54

owenrumney force-pushed the feat/add-update-checking branch 2 times, most recently from 4a269dd to be383c3 Compare March 17, 2025 13:46

owenrumney commented Mar 17, 2025

View reviewed changes

pkg/commands/artifact/run.go Show resolved Hide resolved

owenrumney marked this pull request as ready for review April 14, 2025 11:26

knqyf263 reviewed Apr 16, 2025

View reviewed changes

pkg/notification/notice.go Outdated Show resolved Hide resolved

pkg/commands/artifact/run.go Outdated Show resolved Hide resolved

owenrumney force-pushed the feat/add-update-checking branch 2 times, most recently from 9c714fb to f21196a Compare April 16, 2025 18:23

knqyf263 reviewed Apr 17, 2025

View reviewed changes

owenrumney requested review from simar7 and nikpivkin as code owners April 17, 2025 18:39

owenrumney force-pushed the feat/add-update-checking branch from 67acb5e to 5152ff5 Compare April 17, 2025 18:41

itaysk reviewed Apr 18, 2025

View reviewed changes

pkg/flag/scan_flags.go Outdated Show resolved Hide resolved

knqyf263 approved these changes Apr 18, 2025

View reviewed changes

nikpivkin reviewed Apr 18, 2025

View reviewed changes

pkg/notification/option.go Outdated Show resolved Hide resolved

nikpivkin approved these changes Apr 18, 2025

View reviewed changes

owenrumney requested a review from afdesk as a code owner April 22, 2025 08:02

DmitriyLewen reviewed May 5, 2025

View reviewed changes

helm/trivy/Chart.yaml Outdated Show resolved Hide resolved

owenrumney force-pushed the feat/add-update-checking branch from 929742f to bd1feb4 Compare May 5, 2025 18:58

DmitriyLewen reviewed May 6, 2025

View reviewed changes

pkg/notification/notice.go Outdated Show resolved Hide resolved

pkg/notification/notice.go Show resolved Hide resolved

DmitriyLewen approved these changes May 6, 2025

View reviewed changes

owenrumney added 2 commits May 12, 2025 06:15

owenrumney and others added 12 commits May 12, 2025 06:15

docs(flags): update the scan docs

0fbaded

Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

chore: update comment in version checker

6674087

Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

chore: tidy up comment

fb263fa

Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

Update notice.go

f0c4069

Co-authored-by: Teppei Fukuda <knqyf263@gmail.com>

Update notice.go

c5837de

Co-authored-by: Teppei Fukuda <knqyf263@gmail.com>

chore: update the custom headers to remove -x prefix

73457b3

Remove the -x prefix as per RFC6648. While headers are case-insensitve, making custom headers title case as per general convention. Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

feat: change url and disable telemetry flags

b287fdf

- update the URL to check.trivy.cloud/updates - change the flag to disable-telemetry - update tests Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

chore: fix comment

cc750f3

Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

chore: remove check based on offline scan

3a40377

offline scan isn't to be included at the moment, this will be tackled as a different piece of work. tidied up the notices option to be more consistent with the flag it reflects Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

chore: fix rebase issue from linting

6a4f526

Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

fix: use accessor functions for LatestVersion, Warnings and Announcem…

f8873cb

…ents Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

chore: update the endpoint url

c6f5d66

- add support for different formats of date time from the service Signed-off-by: Owen Rumney <owen.rumney@aquasec.com>

owenrumney force-pushed the feat/add-update-checking branch from 52162e0 to c6f5d66 Compare May 12, 2025 05:48

docs: telemetry and updates

eb396c1

owenrumney commented May 21, 2025

View reviewed changes

docs/docs/advanced/telemetry.md Outdated Show resolved Hide resolved

Update telemetry.md

f5bde43

simar7 reviewed May 23, 2025

View reviewed changes

docs/docs/advanced/telemetry.md Outdated Show resolved Hide resolved

simar7 approved these changes May 23, 2025

View reviewed changes

Update telemetry.md

b93ee67

Co-authored-by: simar7 <1254783+simar7@users.noreply.github.com>

DmitriyLewen approved these changes May 23, 2025

View reviewed changes

itaysk approved these changes May 28, 2025

View reviewed changes

knqyf263 added this pull request to the merge queue May 28, 2025

Merged via the queue into main with commit 5a0bf9e May 28, 2025
21 checks passed

knqyf263 deleted the feat/add-update-checking branch May 28, 2025 08:31

aqua-bot mentioned this pull request May 28, 2025

release: v0.63.0 [main] #8809

Open

feat(cli): Add available version checking #8553

feat(cli): Add available version checking #8553

Uh oh!

Conversation

owenrumney commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Example output

Related issues

Checklist

Uh oh!

DmitriyLewen left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

knqyf263 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

knqyf263 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

knqyf263 Apr 17, 2025

Choose a reason for hiding this comment

Uh oh!

owenrumney Apr 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

itaysk commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

knqyf263 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nikpivkin left a comment

Choose a reason for hiding this comment

Uh oh!

itaysk commented Apr 19, 2025

Uh oh!

Uh oh!

DmitriyLewen left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

DmitriyLewen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

simar7 left a comment

Choose a reason for hiding this comment

Uh oh!

DmitriyLewen left a comment

Choose a reason for hiding this comment

Uh oh!

knqyf263 commented May 26, 2025

Uh oh!

Uh oh!

Uh oh!

owenrumney commented Mar 14, 2025 •

edited

Loading

DmitriyLewen left a comment •

edited

Loading

itaysk commented Apr 18, 2025 •

edited

Loading

DmitriyLewen left a comment •

edited

Loading