docs: slim down docs
This commit is contained in:
20
README.md
20
README.md
@@ -7,24 +7,6 @@ Reusable GitHub Actions for [TAS (Tea Advanced Security)](https://github.com/go-
|
||||
### [tas-upload-sarif](tas-upload-sarif/)
|
||||
|
||||
Uploads a SARIF report from a file to TAS and **fails the job** if the API returns `allowed: false`.
|
||||
|
||||
**Example workflow** (e.g. after a security scan that produces SARIF):
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
scan:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
# Run your scanner and produce SARIF (e.g. to results.sarif)
|
||||
# - run: ./run-scanner --output results.sarif
|
||||
|
||||
- name: Upload SARIF to TAS and gate
|
||||
uses: your-org/tas-actions/tas-upload-sarif@v1
|
||||
with:
|
||||
tas-base-url: 'https://tas.example.com'
|
||||
sarif-file: 'results.sarif'
|
||||
```
|
||||
sarif-file: 'results.sarif'
|
||||
|
||||
See [tas-upload-sarif/README.md](tas-upload-sarif/README.md) for all inputs and options.
|
||||
@@ -25,10 +25,10 @@ Reusable GitHub Action that uploads a SARIF report to [TAS (Tea Advanced Securit
|
||||
With explicit owner/repo/branch (e.g. for monorepos or custom refs):
|
||||
|
||||
```yaml
|
||||
- uses: [your-org/tas-actions/tas-upload-sarif@v1](https://gitea.t000-n.de/t.behrendt/tas-actions/tas-upload-sarif@v1)
|
||||
- uses: https://gitea.t000-n.de/t.behrendt/tas-actions/tas-upload-sarif@v1
|
||||
with:
|
||||
tas-base-url: ${{ vars.TAS_BASE_URL }}
|
||||
sarif-file: 'scan-output.sarif'
|
||||
sarif-file: "scan-output.sarif"
|
||||
owner: ${{ github.repository_owner}}
|
||||
repo: ${{ github.event.repository.name }}
|
||||
branch: ${{ github.head_ref }}
|
||||
|
||||
Reference in New Issue
Block a user