Screaming snake cases the examples in the readme (as other github act…

…ion environment variables do)
fossas · Jan 18, 2025 · f8fc496 · f8fc496
1 parent 11374cc
commit f8fc496
Showing 1 changed file with 14 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -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`
@@ -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
 ```
 
@@ -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 }}
 
@@ -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
 ```
 
@@ -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
 ```
 
@@ -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
 ```
 
@@ -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
 ```
 
@@ -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:
@@ -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.
@@ -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
@@ -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
 ```
 
@@ -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
 ```