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

Removing Deprecated V1 options #240

Merged
merged 2 commits into from
Jan 26, 2024
Merged

Removing Deprecated V1 options #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e172cc
Removing Deprecated V1 options
Bwvolleyball Jan 26, 2024
cc1d13b
Remove pinned version for debug/verbose
d-co-white Jan 26, 2024
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
1 change: 0 additions & 1 deletion .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ jobs:
githubToken: ${{ github.token }}
configurationFiles: __tests__/stackhawk.yml
codeScanningAlerts: true
version: 3.3.0
verbose: true
debug: true

Expand Down
35 changes: 1 addition & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
If you have questions or need some help, please email us at support@stackhawk.com.
Loading