Skip to content

Commit 4119caa

Browse files
authored
chore: configure security policy (#3)
Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>
1 parent 1b9922d commit 4119caa

File tree

2 files changed

+66
-2
lines changed

2 files changed

+66
-2
lines changed

README.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
1-
# Inference-Request
2-
Run an inference request to GitHub Models via GitHub Actions.
1+
[![GitHub license](https://img.shields.io/github/license/op5dev/inference-request?logo=apache&label=License)](LICENSE "Apache License 2.0.")
2+
[![GitHub release tag](https://img.shields.io/github/v/release/op5dev/inference-request?logo=semanticrelease&label=Release)](https://github.com/op5dev/inference-request/releases "View all releases.")
3+
*
4+
[![GitHub repository stargazers](https://img.shields.io/github/stars/op5dev/inference-request)](https://github.com/op5dev/inference-request "Become a stargazer.")
5+
6+
# Inference Request via GitHub Action
7+
8+
> [!TIP]
9+
> Run an inference request to GitHub Models via GitHub Action.
10+
11+
</br>
12+
13+
## Usage Examples
14+
15+
</br>
16+
17+
## Security
18+
19+
View [security policy and reporting instructions](SECURITY.md).
20+
21+
> [!TIP]
22+
>
23+
> Pin your GitHub Action to a [commit SHA](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions "Security hardening for GitHub Actions.") to harden your CI/CD pipeline security against supply chain attacks.
24+
25+
</br>
26+
27+
## Changelog
28+
29+
View [all notable changes](https://github.com/op5dev/inference-request/releases "Releases.") to this project in [Keep a Changelog](https://keepachangelog.com "Keep a Changelog.") format, which adheres to [Semantic Versioning](https://semver.org "Semantic Versioning.").
30+
31+
> [!TIP]
32+
>
33+
> All forms of **contribution are very welcome** and deeply appreciated for fostering open-source projects.
34+
>
35+
> - [Create a PR](https://github.com/op5dev/inference-request/pulls "Create a pull request.") to contribute changes you'd like to see.
36+
> - [Raise an issue](https://github.com/op5dev/inference-request/issues "Raise an issue.") to propose changes or report unexpected behavior.
37+
> - [Open a discussion](https://github.com/op5dev/inference-request/discussions "Open a discussion.") to discuss broader topics or questions.
38+
> - [Become a stargazer](https://github.com/op5dev/inference-request/stargazers "Become a stargazer.") if you find this project useful.
39+
40+
</br>
41+
42+
## License
43+
44+
- This project is licensed under the **permissive** [Apache License 2.0](LICENSE "Apache License 2.0.").
45+
- All works herein are my own, shared of my own volition, and [contributors](https://github.com/op5dev/inference-request/graphs/contributors "Contributors.").
46+
- Copyright 2016-present [Rishav Dhar](https://github.com/rdhar "Rishav Dhar's GitHub profile.") — All wrongs reserved.

SECURITY.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Security Policy
2+
3+
> [!TIP]
4+
>
5+
> Pin your GitHub Action to a [commit SHA](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions "Security hardening for GitHub Actions.") to harden your CI/CD pipeline security against supply chain attacks.
6+
7+
</br>
8+
9+
Integrating security in your CI/CD pipeline is critical to practicing DevSecOps. This action aims to be secure by default, and it should be complemented with your own review to ensure it meets your (organization's) security requirements.
10+
11+
## Supported Versions
12+
13+
| Version | Supported |
14+
| :-----: | :-------: |
15+
| v2.x.x | Yes |
16+
| ≤ v1.x.x | No |
17+
18+
## Reporting a Vulnerability
19+
20+
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to <contact@OP5.dev> or reported via [Security Advisory](https://github.com/op5dev/inference-request/security/advisories/new "Create a new security advisory.").

0 commit comments

Comments
 (0)