Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OSV scanner and GitHub actions to home page #2136

Conversation

zahraaalizadeh
Copy link
Collaborator

@zahraaalizadeh zahraaalizadeh commented Apr 24, 2024

This change adds:

  • two code boxes to display usage example for osv-scanner fix for both basic(non-interactive) and advanced (interactive) use cases.
  • Adds a new section to display information about Github Actions Tools
  • Adds a button on top of the Home page to point to the Github Action section

resolves #2085

Screen.Recording.2024-04-26.at.10.28.35.am.mov
Screenshot 2024-04-24 at 8 32 19 pm

@zahraaalizadeh zahraaalizadeh marked this pull request as ready for review April 26, 2024 05:34
@zahraaalizadeh zahraaalizadeh changed the title Issue 2085/add OSV scanner and GitHub actions to home page Add OSV scanner and GitHub actions to home page May 1, 2024
<div id="use-the-github-action" class="mdc-layout-grid__cell--span-12 github-action">
<h2 class="heading">GitHub Action (OSV&#8209;Scanner)</h2>
<p class="description">
The <a href="https://github.com/google/osv-scanner-action" target="_blank">OSV-Scanner GitHub Action</a>
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: we can make this a bit more concise.

OSV-Scanner also provides reusable GitHub workflows that can be easily integrated into CI/CD pipelines to provide continuous vulnerability scanning coverage. This can scan newly added dependencies in pull requests for introduced vulnerabilities, as well as perform regular vulnerability scans for the entire project.

</clipboard-copy>
</div>
<div class="code-card mdc-layout-grid__cell--span-6 mdc-layout-grid__cell--span-12-tablet">
<h3 class="code-card-title">Guided Remediation (advanced)</h3>
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: replace advanced with interactive

Prior to this change the More details button on scanner CLT
tool section, pointed to the osv-scanner github page.

This change updates it to link to osv scanner documentation
page instead.
This change adds a new section to Home page to display
info about github action tool (OSV-Scanner).
@zahraaalizadeh
Copy link
Collaborator Author

Updated the PR. Here is how it looks like:

Screen.Recording.2024-05-08.at.9.59.28.AM.mov

@oliverchang
Copy link
Collaborator

Updated the PR. Here is how it looks like:

Screen.Recording.2024-05-08.at.9.59.28.AM.mov

@zahraaalizadeh thanks. Are your changes pushed? It looks like what's in this PR is not consistent with what's shown in your video.

@zahraaalizadeh zahraaalizadeh force-pushed the issue-2085/add-osv-scanner-and-github-actions-to-home-page branch from 11986b4 to 3e92859 Compare May 8, 2024 02:59
@zahraaalizadeh
Copy link
Collaborator Author

Oops! Just pushed it 😅 Thanks for the heads up!

@oliverchang
Copy link
Collaborator

oliverchang commented May 8, 2024

Thanks @zahraaalizadeh.

I'm running this locally and I see this for GitHub actions:

image

Which doesn't look like it's formatted correctly?

</div>
</div>
<div id="use-the-github-action" class="mdc-layout-grid__cell--span-12 github-action">
<h2 class="heading">GitHub Action (OSV&#8209;Scanner)</h2>
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: we can just call this "GitHub Workflows"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated via 4d3076c

<a class="cta-primary link-button" href="#use-the-cli">CLI Tools</a>
<a class="cta-primary link-button" href="#use-vulnerability-scanner">Vulnerability Scanner</a>
<a class="cta-primary link-button" href="#use-remediation-tools">Remediation Tools</a>
<a class="cta-primary link-button" href="#use-the-github-action">Github Action Tools</a>
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: Can we call this "GitHub Workflows"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

♻️ updated via 4d3076c

@zahraaalizadeh
Copy link
Collaborator Author

I'm running this locally and I see this for GitHub actions:
Which doesn't look like it's formatted correctly?

Thanks, @oliverchang. I couldn't reproduce the issue on my local machine. Could you let me know which browser and configuration you're using? This will help me further investigate the problem.

@oliverchang
Copy link
Collaborator

I'm running this locally and I see this for GitHub actions:
Which doesn't look like it's formatted correctly?

Thanks, @oliverchang. I couldn't reproduce the issue on my local machine. Could you let me know which browser and configuration you're using? This will help me further investigate the problem.

I'm using Chrome 123.0.6312.134 on Chrome OS.

@oliverchang
Copy link
Collaborator

I'm running this locally and I see this for GitHub actions:
Which doesn't look like it's formatted correctly?

Thanks, @oliverchang. I couldn't reproduce the issue on my local machine. Could you let me know which browser and configuration you're using? This will help me further investigate the problem.

I'm using Chrome 123.0.6312.134 on Chrome OS.

My bad, please ignore. It looks like my local CSS was style somehow. It now renders correctly for me.

@oliverchang oliverchang merged commit 0dad37e into google:master May 10, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add osv-scanner fix and GitHub actions to osv.dev home page.
2 participants