https://github.com/hunsche/oss-security-pucpr
https://github.com/hunsche/oss-security-pucpr
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hunsche/oss-security-pucpr
- Owner: hunsche
- License: mit
- Created: 2025-03-22T14:29:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-26T17:30:10.000Z (about 1 year ago)
- Last Synced: 2025-04-26T17:34:20.733Z (about 1 year ago)
- Language: Python
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OSS Security PUCPR
This repository is a simple demonstration of a CI/CD pipeline for basic open source security checks. It was created as part of a DevOps course project.
## 🔍 What It Does
The repository includes a Python script that performs a basic security validation by checking for the presence of essential files in open source projects, such as:
- `LICENSE`
- `README.md`
- `requirements.txt`
These files are commonly expected in well-structured open source projects to ensure legal clarity, documentation, and dependency management.
## ⚙️ CI/CD Pipeline
A GitHub Actions workflow is configured to automatically run the security check script on every push or pull request to the `main` branch. The workflow will fail if any of the required files are missing.
## 📁 Project Structure
```
.
├── .github
│ └── workflows
│ └── security.yml # GitHub Actions workflow
├── check_security.py # Python script to check required files
├── LICENSE # (Required)
├── README.md # (Required)
└── requirements.txt # (Required)
```
## 🧪 How to Run Locally
Make sure you have Python 3.10+ installed, then run:
```bash
python check_security.py
```
## 🧠 Purpose
This project is purely educational. The goal is to simulate a CI/CD use case aligned with open source security practices.