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.

Sign up for GitHub

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

docs(COD-4237): update the documentation #217

Merged
merged 1 commit into from
Jan 31, 2025
Merged

docs(COD-4237): update the documentation #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/update-tag.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:

jobs:
build:
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
env:
GITHUB_TOKEN: ${{ secrets.RELENG_GH_TOKEN }}
steps:
Expand Down
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This repository contains a GitHub Action for using Lacework's code security offe

Before attempting to run this action, you should add three secrets `LW_ACCOUNT_NAME`, `LW_API_KEY` and `LW_API_SECRET` to your GitHub repository (or, better yet, your GitHub organization so they can be shared accross all your repositories). The value for these secrets can be obtained by following the instructions [here](https://docs.lacework.com/console/api-access-keys) to create an API key and then download it.

### On pull requests
### Running on pull requests

To run an analysis on pull requests that highlights new alerts, create a file called `.github/workflows/lacework-code-security-pr.yml` with this content:

Expand All @@ -23,14 +23,14 @@ permissions:
pull-requests: write

env:
LW_ACCOUNT_NAME: ${{ secrets._LW_ACCOUNT_NAME }}
LW_ACCOUNT_NAME: ${{ secrets.LW_ACCOUNT_NAME }}
LW_API_KEY: ${{ secrets.LW_API_KEY }}
LW_API_SECRET: ${{ secrets.LW_API_SECRET }}

name: Lacework Code Security (PR)
jobs:
run-analysis:
runs-on: ubuntu-20.04
runs-on: ubuntu-latest
name: Run analysis
strategy:
matrix:
Expand All @@ -48,7 +48,7 @@ jobs:
with:
target: ${{ matrix.target }}
display-results:
runs-on: ubuntu-20.04
runs-on: ubuntu-latest
name: Display results
needs:
- run-analysis
Expand All @@ -60,14 +60,20 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
```

### On push
### Running on push or in scheduled mode

To run an analysis on pushes that logs alerts, create a file called `.github/workflows/lacework-code-security-push.yml` with this content:
To run an analysis on pushes or on a scheduled fashion and upload findings to the Lacework UI, create a file called `.github/workflows/lacework-code-security-push.yml` with this content:

```yaml
on:
push:
# Run the scan on evey push in main
branches: [main]
# Run the scan evey day at 7:00am
schedule:
- cron: '0 7 * * *'
# To manually trigger scans from the GitHub UI
workflow_dispatch:

env:
LW_ACCOUNT_NAME: ${{ secrets.LW_ACCOUNT_NAME }}
Expand All @@ -77,7 +83,7 @@ env:
name: Lacework Code Security (Push)
jobs:
run-analysis:
runs-on: ubuntu-20.04
runs-on: ubuntu-latest
name: Run analysis
steps:
- name: Checkout repository
Expand Down