Skip to content

Latest commit

ย 

History

History
52 lines (41 loc) ยท 1.66 KB

File metadata and controls

52 lines (41 loc) ยท 1.66 KB

Changelog

All notable changes to the StackHawk CircleCI orb are documented here.

2.0.0

Breaking changes

  • Renamed jobs and parameters to snake_case to conform to CircleCI orb naming conventions (orb-tools review rule RC010).

    Jobs:

    • stackhawk/hawkscan-local โ†’ stackhawk/hawkscan_local
    • stackhawk/hawkscan-remote โ†’ stackhawk/hawkscan_remote

    Parameters (both jobs):

    • api-key โ†’ api_key
    • configuration-files โ†’ configuration_files
    • docker-network โ†’ docker_network (hawkscan_local)
    • app-id โ†’ app_id
    • auth-token โ†’ auth_token
    • docker-image โ†’ docker_image
    • resource-class โ†’ resource_class (hawkscan_remote)

    (host, env, username, password, color, steps are unchanged.)

    Migration: update the job name and any kebab-case parameters in your .circleci/config.yml:

    # before
    - stackhawk/hawkscan-local:
        docker-network: scan_net
        app-id: <your-app-id>
        configuration-files: stackhawk.yml
    # after
    - stackhawk/hawkscan_local:
        docker_network: scan_net
        app_id: <your-app-id>
        configuration_files: stackhawk.yml

Changed

  • Upgraded the build pipeline to circleci/orb-tools@12.1.0 and the canonical two-file Orb Development Kit layout (setup: true config that continues into test-deploy.yml).
  • Extracted the HawkScan run commands into src/scripts/ and pass parameters via the job environment: block (orb-tools review rule RC009). No change to job behavior or parameters.
  • Fixed the HawkScan container working directory rename introduced in StackHawk 3.9.9 (/home/zap/hawk โ†’ /home/steve/hawk).