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

Screaming snake case the example environment variables #54

Closed
wants to merge 1 commit into from
Closed

Screaming snake case the example environment variables #54

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
28 changes: 14 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
- uses: actions/checkout@v3
- uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
```

### `run-tests`
Expand All @@ -57,7 +57,7 @@ jobs:
- uses: actions/checkout@v3
- uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
run-tests: true
```

Expand All @@ -77,7 +77,7 @@ jobs:
- uses: actions/checkout@v3
- uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
run-tests: ${{ github.event_name == 'pull_request' }}
test-diff-revision: ${{ github.event.pull_request.base.sha }}

Expand All @@ -96,7 +96,7 @@ jobs:
- uses: actions/checkout@v3
- uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
container: ubuntu:20.04
```

Expand All @@ -113,7 +113,7 @@ jobs:
- uses: actions/checkout@v3
- uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
branch: some-feature-branch
```

Expand All @@ -130,7 +130,7 @@ jobs:
- uses: actions/checkout@v3
- uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
project: some-project-name
```

Expand All @@ -147,7 +147,7 @@ jobs:
- uses: actions/checkout@v3
- uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
endpoint: fossa.my-company.com
```

Expand All @@ -165,7 +165,7 @@ jobs:
- uses: actions/checkout@v3
- uses: fossas/fossa-action@main
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
debug: true
- uses: actions/upload-artifact@v3
with:
Expand All @@ -175,7 +175,7 @@ jobs:


## Examples
We've provided a few examples of how to use FOSSA's Github Action in your own project. These examples use an API key stored as a Github secret environment variable `fossaAPiKey`.
We've provided a few examples of how to use FOSSA's Github Action in your own project. These examples use an API key stored as a Github secret environment variable `FOSSA_API_KEY`.

### Running a scan
This runs a basic FOSSA scan using FOSSA CLI on a your checked out project.
Expand All @@ -188,7 +188,7 @@ jobs:
- uses: actions/checkout@v3
- uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
```

### Running tests
Expand All @@ -205,12 +205,12 @@ jobs:
- name: "Run FOSSA Scan"
uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}

- name: "Run FOSSA Test"
uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
run-tests: true
```

Expand All @@ -228,13 +228,13 @@ jobs:
- name: "Run FOSSA Scan"
uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
container: ubuntu:20.04

- name: "Run FOSSA Test"
uses: fossas/fossa-action@main # Use a specific version if locking is preferred
with:
api-key: ${{secrets.fossaApiKey}}
api-key: ${{secrets.FOSSA_API_KEY}}
container: ubuntu:20.04
run-tests: true
```
Loading