Skip to content

Commit cb87425

Browse files
docs(COD-4237): update the documentation (#217)
1 parent b14ac8c commit cb87425

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

.github/workflows/update-tag.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66

77
jobs:
88
build:
9-
runs-on: ubuntu-22.04
9+
runs-on: ubuntu-latest
1010
env:
1111
GITHUB_TOKEN: ${{ secrets.RELENG_GH_TOKEN }}
1212
steps:

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This repository contains a GitHub Action for using Lacework's code security offe
1010

1111
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.
1212

13-
### On pull requests
13+
### Running on pull requests
1414

1515
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:
1616

@@ -23,14 +23,14 @@ permissions:
2323
pull-requests: write
2424

2525
env:
26-
LW_ACCOUNT_NAME: ${{ secrets._LW_ACCOUNT_NAME }}
26+
LW_ACCOUNT_NAME: ${{ secrets.LW_ACCOUNT_NAME }}
2727
LW_API_KEY: ${{ secrets.LW_API_KEY }}
2828
LW_API_SECRET: ${{ secrets.LW_API_SECRET }}
2929

3030
name: Lacework Code Security (PR)
3131
jobs:
3232
run-analysis:
33-
runs-on: ubuntu-20.04
33+
runs-on: ubuntu-latest
3434
name: Run analysis
3535
strategy:
3636
matrix:
@@ -48,7 +48,7 @@ jobs:
4848
with:
4949
target: ${{ matrix.target }}
5050
display-results:
51-
runs-on: ubuntu-20.04
51+
runs-on: ubuntu-latest
5252
name: Display results
5353
needs:
5454
- run-analysis
@@ -60,14 +60,20 @@ jobs:
6060
token: ${{ secrets.GITHUB_TOKEN }}
6161
```
6262
63-
### On push
63+
### Running on push or in scheduled mode
6464
65-
To run an analysis on pushes that logs alerts, create a file called `.github/workflows/lacework-code-security-push.yml` with this content:
65+
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:
6666

6767
```yaml
6868
on:
6969
push:
70+
# Run the scan on evey push in main
7071
branches: [main]
72+
# Run the scan evey day at 7:00am
73+
schedule:
74+
- cron: '0 7 * * *'
75+
# To manually trigger scans from the GitHub UI
76+
workflow_dispatch:
7177
7278
env:
7379
LW_ACCOUNT_NAME: ${{ secrets.LW_ACCOUNT_NAME }}
@@ -77,7 +83,7 @@ env:
7783
name: Lacework Code Security (Push)
7884
jobs:
7985
run-analysis:
80-
runs-on: ubuntu-20.04
86+
runs-on: ubuntu-latest
8187
name: Run analysis
8288
steps:
8389
- name: Checkout repository

0 commit comments

Comments
 (0)