-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from step-security/readme
Update README.md
- Loading branch information
Showing
1 changed file
with
19 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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... |