step-security/harden-runner
1
0
Fork 0
mirror of https://github.com/step-security/harden-runner.git synced 2026-06-05 22:47:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #6 from step-security/readme

Browse source 
Update README.md
This commit is contained in:
Varun Sharma 2021-11-18 17:23:37 -08:00 • committed by GitHub
commit a2f1ea31c0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,3 +1,20 @@
# Harden-Runner
<p align="left">
<img src="https://step-security-images.s3.us-west-2.amazonaws.com/Final-Logo-06.png" alt="Step Security Logo" width="340">
</p>
# Harden GitHub Actions Hosted Runner
This GitHub Action deploys the [Step Security Agent](https://github.com/step-security/agent), which is a purpose-built security agent for hosted runners.
To pilot this GitHub Action, add the following code to your GitHub Actions workflow file as the first step. This is the only step needed.
```
steps:
- uses: step-security/harden-runner@main
```
In the workflow logs, you should see a link to security insights and recommendations.
It is being piloted on [this](https://github.com/shivammathur/setup-php) repository. Check out the [workflow files](https://github.com/shivammathur/setup-php/blob/2f5c2edb229fb5b3dcaeb535cb83899b41854672/.github/workflows/node-workflow.yml#L30) and [workflow runs](https://github.com/shivammathur/setup-php/runs/4252355681?check_suite_focus=true#step:3:4).
Work in progress...