Skip to content

Commit adfb0fa

Browse files
committed
Merge branch 'main' into int
2 parents 03f4760 + d8f79f0 commit adfb0fa

File tree

8 files changed

+57
-34
lines changed

8 files changed

+57
-34
lines changed

README.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
<p align="center"><img src="images/banner1.png" height="80" /></p>
2-
3-
<p align="center">
4-
Secure your GitHub repo with ease through automated security fixes
5-
</p>
1+
<p align="center"><img src="images/banner1.png" width="350" /></p>
62

73
<div align="center">
84

@@ -14,42 +10,22 @@ Secure your GitHub repo with ease through automated security fixes
1410
</div>
1511

1612
<p align="center">
17-
<img src="images/secure-repo.gif" alt="Secure repo screenshot" >
13+
Automatically apply security best practices in your GitHub repository
14+
</p>
15+
16+
<p align="center">
17+
<img src="images/secure-repo-1.gif" alt="Secure repo screenshot" >
1818
</p>
1919

2020
<h3>
21+
<a href="#catalog-of-fixes">Catalog of Fixes</a>
22+
<span> • </span>
2123
<a href="#quickstart">Quickstart</a>
22-
<span> • </span>
23-
<a href="#functionality-overview">Functionality</a>
2424
<span> • </span>
2525
<a href="#contributing">Contributing</a>
2626
</h3>
2727

28-
## Quickstart
29-
30-
### Hosted Instance: [app.stepsecurity.io/securerepo](https://app.stepsecurity.io/securerepo)
31-
32-
To secure your GitHub repo using a pull request:
33-
34-
- Go to https://app.stepsecurity.io/securerepo and enter your public GitHub repository
35-
- Log in using your GitHub Account (no need to install any App or grant `write` access)
36-
- View recommendations and click `Create pull request.` Here is an example pull request: https://github.com/electron/electron/pull/36343.
37-
38-
### Integration with OpenSSF Scorecard
39-
40-
- Add [OpenSSF Scorecards](https://github.com/ossf/scorecard-action) starter workflow
41-
- View the Scorecard results in GitHub Code Scanning UI
42-
- Follow the remediation tip that points to https://app.stepsecurity.io
43-
44-
<p align="center">
45-
<img src="images/SecureWorkflowsIntegration.png" alt="Secure repo Scorecard integration screenshot" width="600">
46-
</p>
47-
48-
### Self Hosted
49-
50-
To create an instance of Secure Workflows, deploy _cloudformation/ecr.yml_ and _cloudformation/resources.yml_ CloudFormation templates in your AWS account. You can take a look at _.github/workflows/release.yml_ for reference.
51-
52-
## Functionality
28+
## Catalog of Fixes
5329

5430
1. [Automatically set minimum GITHUB_TOKEN permissions](#1-automatically-set-minimum-github_token-permissions)
5531
2. [Add Harden-Runner GitHub Action to each job](#2-add-harden-runner-github-action-to-each-job)
@@ -227,14 +203,38 @@ Before the fix, you do not have a OpenSSF Scorecard workflow.
227203

228204
After the fix, a `scorecards.yml` GitHub Actions workflow gets added to your project.
229205

230-
**Pull request example**: https://github.com/mcornick/clilol/pull/14
206+
**Pull request example**: https://github.com/microsoft/CLRInstrumentationEngine/pull/527
231207

232208
This pull request adds OpenSSF Scorecard to the list of workflows.
233209

234210
#### How does Secure-Repo fix this issue?
235211

236212
Secure-Repo has a [workflow-templates](https://github.com/step-security/secure-repo/tree/main/workflow-templates) folder. This folder has the default Scorecard workflow, which gets added as part of the pull request.
237213

214+
## Quickstart
215+
216+
### Hosted Instance: [app.stepsecurity.io/securerepo](https://app.stepsecurity.io/securerepo)
217+
218+
To secure your GitHub repo using a pull request:
219+
220+
- Go to https://app.stepsecurity.io/securerepo and enter your public GitHub repository
221+
- Log in using your GitHub Account (no need to install any App or grant `write` access)
222+
- View recommendations and click `Create pull request.` Here is an example pull request: https://github.com/electron/electron/pull/36343.
223+
224+
### Integration with OpenSSF Scorecard
225+
226+
- Add [OpenSSF Scorecards](https://github.com/ossf/scorecard-action) starter workflow
227+
- View the Scorecard results in GitHub Code Scanning UI
228+
- Follow the remediation tip that points to https://app.stepsecurity.io
229+
230+
<p align="center">
231+
<img src="images/SecureWorkflowsIntegration.png" alt="Secure repo Scorecard integration screenshot" width="600">
232+
</p>
233+
234+
### Self Hosted
235+
236+
To create an instance of Secure Workflows, deploy _cloudformation/ecr.yml_ and _cloudformation/resources.yml_ CloudFormation templates in your AWS account. You can take a look at _.github/workflows/release.yml_ for reference.
237+
238238
## Contributing
239239

240240
Contributions are welcome!

images/secure-repo-1.gif

3.24 MB
Loading

images/secure-repo.gif

-2.76 MB
Binary file not shown.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: 'Dependency Review'
2+
github-token:
3+
action-input:
4+
input: repo-token
5+
is-default: true
6+
permissions:
7+
pull-requests: write
8+
pull-requests-reason: to post comments on PRs #Checkout: https://github.com/actions/dependency-review-action/blob/e3fb5152be474702523c77d8f5ecd4c0a5bde872/action.yml#L44
9+
pull-requests-if: ${{ contains(with, 'comment-summary-in-pr') && with['comment-summary-in-pr'] == 'true' }}
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
name: 'gabrielbb/xvfb-action' # GabrielBB/xvfb-action
2+
# GITHUB_TOKEN not used
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
name: 'run-cmake' # lukka/run-cmake
2+
# GITHUB_TOKEN not used
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
name: "cargo-cache" # RustCrypto/actions/cargo-cache
2+
# GITHUB_TOKEN not used
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
name: 'Run on architecture'
2+
github-token:
3+
action-input:
4+
input: githubToken
5+
is-default: false
6+
permissions:
7+
packages: write
8+
packages-reason: to cache docker images #Reference: https://github.com/uraimo/run-on-arch-action/blob/a8003307a739516fdd80ee6d3da8924db811b8da/action.yml#L17

0 commit comments

Comments
 (0)