File tree Expand file tree Collapse file tree 3 files changed +46
-2
lines changed
Expand file tree Collapse file tree 3 files changed +46
-2
lines changed Original file line number Diff line number Diff line change 99 - name : Checkout
1010 uses : actions/checkout@v4
1111
12+ - name : Configure AWS Credentials
13+ uses : aws-actions/configure-aws-credentials@v4
14+ with :
15+ role-to-assume : arn:aws:iam::576599896960:role/GitHubOpenIdConnect
16+ role-session-name : clickbom-test
17+ aws-region : us-east-1
18+
1219 - name : Test ClickBOM Action
1320 uses : ./
1421 id : test_clickbom
Original file line number Diff line number Diff line change 44
55Downloads SBOMs from GitHub. Uploads to S3 and ClickHouse.
66
7- # Inputs
7+ ## Inputs
88
99| Name | Description | Default | Required | Sensitive |
1010| --------------------- | ------------------------------------ | -------------- | -------- | --------- |
@@ -19,3 +19,40 @@ Downloads SBOMs from GitHub. Uploads to S3 and ClickHouse.
1919| sbom-path | Path to SBOM file in the repository | sbom.json | false | false |
2020| ref | Git reference (branch, tag, commit) | main | false | false |
2121| clickhouse-url | ClickHouse URL for uploads | | false | false |
22+
23+ ## Usage
24+
25+ ### Same Repository
26+
27+ Simple example of downloading the SBOM from the same repository and uploading it to S3.
28+
29+ ``` yaml
30+ name : Upload SBOM
31+ on :
32+ push :
33+ branches :
34+ - main
35+ jobs :
36+ clickbom :
37+ runs-on : ubuntu-latest
38+ steps :
39+ - name : Checkout repository
40+ uses : actions/checkout@v2
41+
42+ - name : Configure AWS Credentials
43+ id : aws-creds
44+ uses : aws-actions/configure-aws-credentials@v1
45+ with :
46+ role-to-assume : arn:aws:iam::012345678912:role/GitHubOIDCRole
47+ role-session-name : clickbom-session
48+ aws-region : us-east-1
49+
50+ - name : Upload SBOM
51+ uses : ./
52+ with :
53+ github-token : ${{ secrets.GITHUB_TOKEN }}
54+ aws-access-key-id : ${{ steps.aws-creds.outputs.aws-access-key-id }}
55+ aws-secret-access-key : ${{ steps.aws-creds.outputs.aws-secret-access-key }}
56+ s3-bucket : my-sbom-bucket
57+ s3-key : clickbom.json
58+ ` ` `
Original file line number Diff line number Diff line change @@ -174,7 +174,7 @@ main() {
174174 log_info " Starting ClickBOM GitHub Action for SBOM processing"
175175
176176 # Validate environment
177- # validate_env
177+ validate_env
178178
179179 # Set defaults for optional variables
180180# local sbom_path="${SBOM_PATH:-sbom.json}"
You can’t perform that action at this time.
0 commit comments