Skip to content

Conversation

@camicano
Copy link

Please go to the Preview tab and select the appropriate template:

@hashicorp-cla-app
Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 24, 2025

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Wed Oct 29 15:41:59 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Wed Oct 29 15:35:26 UTC 2025

@camicano camicano marked this pull request as ready for review October 24, 2025 18:55
@camicano camicano requested review from a team as code owners October 24, 2025 18:55
@camicano camicano requested a review from rmainwork October 24, 2025 18:55
@github-actions
Copy link
Contributor

github-actions bot commented Oct 24, 2025

Broken Link Checker

No broken links found! 🎉


## Event states

- **New** - the default state when HCP Vault Radar creates a new event
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: the default status?

@camicano camicano changed the title Event state RADAR Event state Oct 29, 2025
---
page_title: HCP Vault Radar event workflow
description: >-
HCP Vault Radar event workflow and its states
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Do we need to change the terminology to status? I see state used a bunch in this page 😅

- **Secret Revoked** - set by a developer to confirm they revoked the secret value.
- **Resolved** - set by a developer to confirm remediation is complete
- **False Positive** - set by a developer to confirm the event is a false positive
- **Ignore Rule** - set automatically when a developer uses the inline ignore rule or sets an ignore rule within a repo via YAML file. To learn more about [inline ignore rules](./write-inline-ignore-rules).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Should we also add that Ignore Rule can't be set manually too? I saw it was called out for Notified ?

- **Resolved** - set by a developer to confirm remediation is complete
- **False Positive** - set by a developer to confirm the event is a false positive
- **Ignore Rule** - set automatically when a developer uses the inline ignore rule or sets an ignore rule within a repo via YAML file. To learn more about [inline ignore rules](./write-inline-ignore-rules).
- **Not Important** - sets automatically when an event meets a global ignore rule's criteria. To learn more about [global ignore rules](./write-global-ignore-rules).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users can also set the event status to Not Important manually right. I think it would be nice to distinguish between False Positive and Not Important using an example to avoid any confusion

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And do we include any more information around other times we automatically put it in Not Important status? We have a list in the code, but includes when the secret is in a test file, in a readme file, etc

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, there should be a corresponding tag in the event details when we automatically set it to Not Important

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants