Skip to content

Commit 28d6734

Browse files
authored
Merge branch 'main' into v2_7_4
2 parents 110b538 + 4135ee6 commit 28d6734

File tree

4 files changed

+27
-55
lines changed

4 files changed

+27
-55
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
5555
## Enforcement
5656

5757
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at opensource@github.com. All
58+
reported by contacting the project team at <opensource@github.com>. All
5959
complaints will be reviewed and investigated and will result in a response that
6060
is deemed necessary and appropriate to the circumstances. The project team is
6161
obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -72,4 +72,3 @@ available at [http://contributor-covenant.org/version/1/4][version]
7272

7373
[homepage]: http://contributor-covenant.org
7474
[version]: http://contributor-covenant.org/version/1/4/
75-

README.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
1+
<!-- markdownlint-disable -->
12
<div align="center">
23
<h1>GitHub Policy as Code</h1>
34

4-
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/advanced-security/policy-as-code)
5-
[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/advanced-security/policy-as-code/main.yml?style=for-the-badge)](https://github.com/advanced-security/policy-as-code/actions/workflows/python-package.yml?query=branch%3Amain)
6-
[![GitHub Issues](https://img.shields.io/github/issues/advanced-security/policy-as-code?style=for-the-badge)](https://github.com/advanced-security/policy-as-code/issues)
7-
[![GitHub Stars](https://img.shields.io/github/stars/advanced-security/policy-as-code?style=for-the-badge)](https://github.com/advanced-security/policy-as-code)
8-
[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)
5+
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)][github]
6+
[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/advanced-security/policy-as-code/main.yml?style=for-the-badge)][github-actions]
7+
[![GitHub Issues](https://img.shields.io/github/issues/advanced-security/policy-as-code?style=for-the-badge)][github-issues]
8+
[![GitHub Stars](https://img.shields.io/github/stars/advanced-security/policy-as-code?style=for-the-badge)][github]
9+
[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)][license]
910

1011
</div>
12+
<!-- markdownlint-restore -->
1113

1214
## Overview
1315

14-
GitHub's Policy as Code project is designed to allow users and organizations to configure their Risk threshold for security issues reported by GitHub Advanced Security Platform.
15-
The main goal is to help make sure that before publishing your application to productions, development, etc. you can validate if the application has any security issues that need to be addressed.
16+
[GitHub's Policy as Code][github] project is designed to allow users and organizations to configure their Risk
17+
threshold for security issues reported by GitHub Advanced Security Platform.
18+
The main goal is to help make sure that before publishing your application to productions, development, etc.
19+
you can validate if the application has any security issues that need to be addressed.
1620

1721
## ✨ Features
1822

1923
- Highly Configurable
2024
- Re-usable across repositories
21-
- Supports all GitHub Advanced Security Features
25+
- Supports all [GitHub Advanced Security][advanced-security] Features
2226
- [Code Scanning][github-codescanning]
2327
- [Secret Scanning][github-secretscanning]
2428
- [Supply chain / Dependabot][github-supplychain]
@@ -35,22 +39,25 @@ The main goal is to help make sure that before publishing your application to pr
3539

3640
Here is how you can quickly setup policy-as-code.
3741

42+
> [!TIP]
43+
> Checkout the GitHub Actions [Policy as Code Examples][examples-actions]
44+
3845
```yaml
3946
# Policy as Code
4047
- name: Advance Security Policy as Code
4148
uses: advanced-security/policy-as-code@v2.7.4
4249
```
4350
44-
> [!TIP]
45-
> Checkout the GitHub Actions [Policy as Code Examples][examples-actions]
46-
4751
> [!WARNING]
4852
> The GitHub Action does not install Python on the runner. Please checkout at [the `actions/setup-python` Action][python-setup]
4953

5054
### CLI
5155

5256
The Policy as Code project is a self-contained Python based CLI tool.
5357

58+
> [!NOTE]
59+
> All of the Dependencies for [Policy as Code are vendored][vendored] into this repository
60+
5461
**Bash / Zsh:**
5562

5663
```bash
@@ -68,9 +75,6 @@ cd policy-as-code
6875
.\policy-as-code.ps1 --help
6976
```
7077

71-
> [!NOTE]
72-
> All of the Dependencies for [Policy as Code are vendored][vendored] into this repository
73-
7478
> [!TIP]
7579
> Checkout the samples of [how to use / run the cli with examples][examples-cli].
7680

@@ -296,17 +300,20 @@ Please refer to [MIT][license] for the full terms.
296300
<!-- Resources -->
297301

298302
[license]: ./LICENSE
303+
[github]: https://github.com/advanced-security/policy-as-code
299304
[github-issues]: https://github.com/advanced-security/policy-as-code/issues
305+
[github-actions]: https://github.com/advanced-security/policy-as-code/actions
306+
307+
[advanced-security]: https://github.com/features/security
300308
[github-codescanning]: https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning
301309
[github-secretscanning]: https://docs.github.com/en/code-security/secret-scanning/about-secret-scanning
302310
[github-supplychain]: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security
303-
[requirements]: https://github.com/advanced-security/policy-as-code#requirements
311+
304312
[python-setup]: https://github.com/actions/setup-python
305313
[vendored]: https://github.com/advanced-security/policy-as-code/tree/main/vendor/README.md
306-
[docs]: https://github.com/advanced-security/policy-as-code/tree/main/docs
307-
[examples]: https://github.com/advanced-security/policy-as-code/tree/main/examples
308314
[examples-actions]: https://github.com/advanced-security/policy-as-code/tree/main/examples/workflows
309315
[examples-cli]: https://github.com/advanced-security/policy-as-code/tree/main/examples/scripts
316+
310317
[permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#overview
311318
[permissions-codescanning]: https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
312319
[permissions-secretscanning]: https://docs.github.com/en/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository

SECURITY.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

SUPPORT.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11

2-
# Support
2+
# Support
33

44
## How to file issues and get help
55

66
This project uses GitHub issues to track bugs and feature requests.
77
Please search the existing issues before filing new issues to avoid duplicates.
88
For new issues, file your bug or feature request as a new issue.
99

10-
For help or questions about using this project, please use the GitHub Discussions.
11-
10+
For help or questions about using this project, please use the GitHub Discussions.
1211

1312
This repository is under active development and maintained by GitHub staff and the community.
1413
We will do our best to respond to support, feature requests, and community questions in a timely manner.
1514

16-
1715
## GitHub Support Policy
1816

1917
Support for this project is limited to the resources listed above.
20-

0 commit comments

Comments
 (0)