Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -190,4 +190,10 @@ SESSION_SUMMARY.md
# Cursor AI configuration files (local development settings)
.cursorrules
.cursorignore
CURSOR_CONFIGURATION.md
CURSOR_CONFIGURATION.md

# Internal/maintainer documentation (not for public repository)
PUBLISHING_GUIDE.md
RELEASE_CHECKLIST.md
IMPLEMENTATION_SUMMARY.md
COMMIT_GUIDE.md
73 changes: 73 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,79 @@ All notable changes to DockSec will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.0.20] - 2026-01-09

### Added
- πŸ“š **Comprehensive Documentation Suite**
- Complete CHANGELOG.md with full version history from v0.0.3 to present
- SECURITY.md with vulnerability reporting process and security best practices
- CONTRIBUTING.md with detailed contribution guidelines and development setup
- PUBLISHING_GUIDE.md for maintainers

- πŸ“ **Complete Examples Directory**
- Secure Python Flask application example (Score: 90+) with best practices
- Vulnerable Node.js application example (Score: 30-) for educational purposes
- Multi-stage Golang build example (Score: 95+) with distroless base
- Detailed README for each example explaining security features
- Examples overview and learning path guide

- 🎫 **GitHub Templates**
- Bug report issue template with structured format
- Feature request issue template with use case analysis
- Question issue template for community support
- Pull request template with comprehensive checklist

- πŸ“– **README Enhancements**
- Quick Start section with 3-step getting started guide
- Examples & Screenshots section with sample output
- Documentation section linking to all major docs
- Roadmap section showing upcoming features
- Code quality badges (PyPI version, Python version, CI status, Code style)

### Fixed
- πŸ”— **Broken Links and References**
- Fixed GitHub stars badge URL (docksec/docksec β†’ advaitpatel/DockSec)
- Removed placeholder Docker Hub link
- Fixed CONTRIBUTING.md reference (file now exists)
- Replaced "Coming Soon" demo video section with actual examples

- 🎨 **Badge Updates**
- Corrected repository URLs in all badges
- Added PyPI version badge
- Added Python version support badge
- Added CI/CD status badge
- Added code style (black) badge

### Improved
- πŸ“ **Documentation Quality**
- Better README structure and navigation
- More professional appearance for open source promotion
- Clear learning paths and getting started guides
- Comprehensive troubleshooting section
- Security-first documentation approach

- πŸ—οΈ **Repository Structure**
- Professional GitHub presence with all templates
- Clear contribution workflow
- Security policy for vulnerability reports
- Examples demonstrating best practices

### Developer Experience
- Complete development environment setup guide
- Code style and testing guidelines
- Commit message conventions
- Local testing procedures before PyPI publication

### Community
- Clear paths for bug reports, feature requests, and questions
- Recognition system for contributors
- Transparent roadmap and feature voting

### Notes
This release focuses on documentation, community building, and making DockSec ready for broader open source promotion. No functional changes to the core scanning engine.

---

## [0.0.19] - 2025-06-26

### Added
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import glob
setup(
name="docksec",
version="0.0.18",
version="0.0.20",
description="AI-Powered Docker Security Analyzer",
long_description=open("README.md").read(),
long_description_content_type="text/markdown",
Expand Down