Skip to content

Commit c65a73a

Browse files
Update README.md
updated readme.md
1 parent adcf8a5 commit c65a73a

File tree

1 file changed

+74
-4
lines changed

1 file changed

+74
-4
lines changed

README.md

Lines changed: 74 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,77 @@ DESCRIPTION:</b>&emsp;&emsp;&emsp;&emsp;&emsp;&nbsp;This repo will be used as a
88
*******************************************************************************<br>
99
<br>
1010
<br>
11+
12+
*******************************************************************************
13+
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;GETTING STARTED GUIDE
14+
*******************************************************************************
15+
<b>Use this section to clone or fork this repo and configure GitHub Security <br>
16+
DevOps scanning tools (MSDO) in your own environment.</b><br>
17+
<br>
18+
-Built with no external GitHub Actions — works in restricted org environments <br>
19+
-Includes secret scanning, SARIF upload, and Defender for Cloud integration<br>
20+
<br>
21+
---<br>
22+
<br>
23+
<b>WHAT'S INCLUDED:</b><br>
24+
- Microsoft Security DevOps scanning (`credscan`, `binskim`, `checkov`, etc.)<br>
25+
- Secret scanning using `credscan`<br>
26+
- Self-hosted SARIF uploader (composite GitHub Action)<br>
27+
- Manual .NET 6 install (no external dependencies)<br>
28+
- Fully functional SARIF upload to GitHub Code Scanning<br>
29+
<br>
30+
---<br>
31+
<br>
32+
<b>HOW TO SET UP:</b><br>
33+
<br>
34+
<b>1. Fork the repository</b> <br>
35+
> [Click here to fork](https://github.com/theangrytech-git/MSDO/fork)<br>
36+
<br>
37+
<b>2. Add a `GH_TOKEN` secret:</b> <br>
38+
Go to **Settings → Secrets and variables → Actions**, then add:<br>
39+
<br>
40+
| Name | Description |<br>
41+
|-----------|------------------------------------|<br>
42+
| GH_TOKEN | GitHub PAT with `repo` permissions (optional, usually not needed if using `${{ secrets.GITHUB_TOKEN }}`) |<br>
43+
<br>
44+
---<br>
45+
<br>
46+
<b>INCLUDED WORKFLOWS:</b><br>
47+
<br>
48+
| Workflow Name | Purpose |<br>
49+
|-------------------------|-----------------------------------------------|<br>
50+
| `msdo-main-pipeline.yml` | Orchestrates all security scans + uploads |<br>
51+
| `msdo-reusable.yml` | Performs MSDO scans on infra/code/containers |<br>
52+
| `msdo-secret-scanning.yml` | Runs `credscan` for secret detection |<br>
53+
| `.github/actions/upload-sarif/` | Composite action to upload SARIF locally |<br>
54+
<br>
55+
---<br>
56+
<br>
57+
<b>HOW TO RUN:</b><br>
58+
<br>
59+
- Trigger automatically on push to `main`<br>
60+
- Or manually from the **Actions** tab → Select **workflow** → Click **Run workflow**<br>
61+
<br>
62+
---<br>
63+
<br>
64+
<b>SYSTEM REQUIREMENTS:</b><br>
65+
<br>
66+
- Runner: `ubuntu-latest`<br>
67+
- .NET 6 SDK is installed via script in workflow<br>
68+
- `gh` CLI is already available on GitHub-hosted runners<br>
69+
<br>
70+
---<br>
71+
<br>
72+
<b>OUTPUT:</b><br>
73+
<br>
74+
- Results are uploaded to **GitHub Code Scanning Alerts**<br>
75+
- Optionally ingested into **Microsoft Defender for Cloud**<br>
76+
<br>
77+
---<br>
78+
<br>
79+
<b>NEED HELP?</b><br>
1180
<br>
81+
Open an issue or contact [@theangrytech-git](https://github.com/theangrytech-git)<br><br>
1282
*******************************************************************************<br>
1383
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;RESOURCE VISUALISATION<br>
1484
*******************************************************************************<br>
@@ -33,8 +103,8 @@ map of how this solution is made up.<br>
33103
*******************************************************************************<br>
34104
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;ESTIMATE COSTS (£)<br>
35105
*******************************************************************************<br>
36-
Daily:&emsp;<br>
37-
Weekly:&emsp;<br>
38-
Monthly:&emsp;<br>
39-
Yearly:&emsp;<br>
106+
Daily: £0.00<br>
107+
Weekly: £0.00<br>
108+
Monthly: £0.00<br>
109+
Yearly: £0.00<br>
40110

0 commit comments

Comments
 (0)