From 9e172cc8b40e45b75a26fe888a28c00b53eb8755 Mon Sep 17 00:00:00 2001 From: Brandon Ward Date: Fri, 26 Jan 2024 12:50:31 -0700 Subject: [PATCH 1/2] Removing Deprecated V1 options --- README.md | 35 +---------------------------------- 1 file changed, 1 insertion(+), 34 deletions(-) diff --git a/README.md b/README.md index b6b7554..652f6c6 100644 --- a/README.md +++ b/README.md @@ -191,39 +191,6 @@ jobs: version: 2.7.0 ``` -## Deprecated options (version 1) - -### `environmentVariables` - -**Optional** A list of environment variable to pass to HawkScan. Environment variables can be separated with spaces, commas, or newlines. - -For example: -```yaml -jobs: - stackhawk-hawkscan: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: stackhawk/hawkscan-action@v1.3.4 - with: - apiKey: ${{ secrets.HAWK_API_KEY }} - environmentVariables: APP_HOST APP_ENV - env: - APP_HOST: http://example.com - APP_ENV: Pre-Production -``` - -### `network` - -**Optional** Docker network settings for running HawkScan. Defaults to `host`. - -The following options for `network` are available: -- **`host`** (default): Use Docker host networking mode. HawkScan will run with full access to the GitHub virtual environment hosts network stack. This works in most cases if your scan target is a remote URL or a localhost address. -- **`bridge`**: Use the default Docker bridge network setting for running the HawkScan container. This works in most cases if your scan target is a remote URL or a localhost address. -- **`NETWORK`**: Use the user-defined Docker bridge network, `NETWORK`. This network may be created with `docker network create`, or `docker-compose`. This is appropriate for scanning other containers running locally on the GitHub virtual environment within a named Docker network. - -See the [Docker documentation](https://docs.docker.com/engine/reference/run/#network-settings) for more details on Docker network settings. - ## Examples The following example shows how to run HawkScan with a StackHawk platform API key stored as a GitHub Actions secret environment variable, `HAWK_API_KEY`. In this workflow, GitHub Actions will checkout your repository, build your Python app, and run it. It then uses the HawkScan Action to run HawkScan with the given API key. HawkScan automatically finds the `stackhawk.yml` configuration file at the root of your repository and runs a scan based on that configuration. @@ -299,4 +266,4 @@ Due to the nature of powershell and how we call java, this defect may not fail a ## Need Help? -If you have questions or need some help, please email us at support@stackhawk.com. \ No newline at end of file +If you have questions or need some help, please email us at support@stackhawk.com. From cc1d13b828bab06d258149cd0252fc786b49664c Mon Sep 17 00:00:00 2001 From: Dana White Date: Fri, 26 Jan 2024 13:29:44 -0700 Subject: [PATCH 2/2] Remove pinned version for debug/verbose --- .github/workflows/test.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index bb314f4..ab6fe34 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -73,7 +73,6 @@ jobs: githubToken: ${{ github.token }} configurationFiles: __tests__/stackhawk.yml codeScanningAlerts: true - version: 3.3.0 verbose: true debug: true