All notable changes to the StackHawk CircleCI orb are documented here.
-
Renamed jobs and parameters to snake_case to conform to CircleCI orb naming conventions (orb-tools
reviewrule RC010).Jobs:
stackhawk/hawkscan-localโstackhawk/hawkscan_localstackhawk/hawkscan-remoteโstackhawk/hawkscan_remote
Parameters (both jobs):
api-keyโapi_keyconfiguration-filesโconfiguration_filesdocker-networkโdocker_network(hawkscan_local)app-idโapp_idauth-tokenโauth_tokendocker-imageโdocker_imageresource-classโresource_class(hawkscan_remote)
(
host,env,username,password,color,stepsare 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
- Upgraded the build pipeline to
circleci/orb-tools@12.1.0and the canonical two-file Orb Development Kit layout (setup: trueconfig that continues intotest-deploy.yml). - Extracted the HawkScan run commands into
src/scripts/and pass parameters via the jobenvironment:block (orb-toolsreviewrule 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).