{"id":26164718,"url":"https://github.com/optum/sourcehawk-scan-github-action","last_synced_at":"2026-04-24T10:04:05.937Z","repository":{"id":51256451,"uuid":"306368202","full_name":"Optum/sourcehawk-scan-github-action","owner":"Optum","description":"This action runs a sourcehawk scan on the repository source code","archived":false,"fork":false,"pushed_at":"2023-03-08T17:30:35.000Z","size":38,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-12-19T20:24:14.170Z","etag":null,"topics":["compliance-as-code","compliance-automation","github-actions","github-actions-docker","sourcehawk"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Optum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-22T14:44:21.000Z","updated_at":"2022-06-07T02:08:33.000Z","dependencies_parsed_at":"2025-03-11T15:42:40.077Z","dependency_job_id":"72126d62-921f-4424-9ed4-bca204a33ebf","html_url":"https://github.com/Optum/sourcehawk-scan-github-action","commit_stats":{"total_commits":33,"total_committers":4,"mean_commits":8.25,"dds":"0.24242424242424243","last_synced_commit":"370ec8ab57741c8c3a62337315e6e9bf8b32fa00"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/Optum/sourcehawk-scan-github-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fsourcehawk-scan-github-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fsourcehawk-scan-github-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fsourcehawk-scan-github-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fsourcehawk-scan-github-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Optum","download_url":"https://codeload.github.com/Optum/sourcehawk-scan-github-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fsourcehawk-scan-github-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32218290,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T09:47:08.147Z","status":"ssl_error","status_checked_at":"2026-04-24T09:46:41.165Z","response_time":64,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compliance-as-code","compliance-automation","github-actions","github-actions-docker","sourcehawk"],"created_at":"2025-03-11T15:39:55.776Z","updated_at":"2026-04-24T10:04:05.914Z","avatar_url":"https://github.com/Optum.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sourcehawk Scan Github Action\n\n![Latest Version](https://img.shields.io/github/v/tag/optum/sourcehawk-scan-github-action?label=version\u0026sort=semver) \n[![Build Status](https://github.com/optum/sourcehawk-scan-github-action/workflows/CI/badge.svg)](https://github.com/optum/sourcehawk-scan-github-action/actions) \n[![Sourcehawk Scan](https://github.com/optum/sourcehawk-scan-github-action/workflows/Sourcehawk%20Scan/badge.svg)](https://github.com/optum/sourcehawk-scan-github-action/actions)\n\n\nThis action runs a `sourcehawk` scan on the repository source code.\n\n## Inputs\n\n### `repository-root`\n\nThe root of the source code to scan\n\n**Default**: `.` (root of the repository)\n\n### `config-file`\n\nThe configuration file path (relative path, absolute path, or even URL)\n\n**Default**: `sourcehawk.yml`\n\n### `output-format`\n\nThe output format of the scan\n\n**Default**: `TEXT`\n\n**Valid Values**: `TEXT`, `JSON`, `MARKDOWN`\n\n### `output-file`\n\nThe configuration file path\n\n**Default**: `sourcehawk-scan-results.txt`\n\n### `fail-on-warnings`\n\nWhether or not to fail the scan if only warnings exist\n\n**Default**: `false`\n\n### `fail-build`\n\nWhether or not to fail the build if the scan fails\n\n**Default**: `true`\n\n## Outputs\n\n### `scan-passed`\n\nBoolean value determining if the scan has passed - `true` if the passed, `false` otherwise\n\n## Example usage\n\n### Basic\nThe below example accepts all the defaults\n\n```yaml\nuses: optum/sourcehawk-scan-github-action@v1\n```\n\n### Fail if Warnings Found\nScan will be considered a failure, if warnings are found\n\n```yaml\nuses: optum/sourcehawk-scan-github-action@v1\n  with:\n    fail-on-warnings: true\n```\n\n### Custom Configuration File\nProvide the location to a configuration file in a custom path\n\n```yaml\nuses: optum/sourcehawk-scan-github-action@v1\n  with:\n    config-file: .sourcehawk/config.yml\n```\n\n### JSON Output Format\nOutput the scan results in `JSON` format\n\n```yaml\nuses: optum/sourcehawk-scan-github-action@v1\n  with:\n    output-format: JSON\n    output-file: sourcehawk-scan-results.json\n```\n\n## Example Workflow\nBelow is an example workflow to run a scan on pull requests.  The workflow checks out the source code, runs the scan, \nprints that the scan passed if it was successful, and then archives the scan results file.\n\n```yaml\nname: Build\non:\n  pull_request:\n    branches:\n      - main\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n      - name: Run Sourcehawk Scan\n        id: sourcehawk\n        uses: optum/sourcehawk-scan-github-action@v1\n        with:\n          output-format: JSON\n          output-file: sourcehawk-scan-results.json\n      - name: Determine Sourcehawk Scan Results\n        if: steps.sourcehawk.outputs.scan-passed == 'true'\n        run: echo \"Sourcehawk scan passed!\"\n      - name: Upload Scan Results\n        uses: actions/upload-artifact@v2\n        with:\n          name: sourcehawk\n          path: sourcehawk-scan-results.json\n```\n\n## License\n\nThe `Dockerfile`, shell scripts, and documentation in the github action are released with the \n[Apache 2.0](https://github.com/Optum/sourcehawk-scan-github-action/blob/main/LICENSE) license.\n\n## Contributing\n\nPlease read our [CONTRIBUTING.md](https://github.com/Optum/sourcehawk-scan-github-action/blob/main/CONTRIBUTING.md) for guidelines on contributing to this github action.\n\n### Testing Locally\n\n```sh\n./test.sh\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptum%2Fsourcehawk-scan-github-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foptum%2Fsourcehawk-scan-github-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptum%2Fsourcehawk-scan-github-action/lists"}