diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d4d879b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,21 @@ +# Changelog + +All notable changes to this project are documented here. Format loosely follows [Keep a Changelog](https://keepachangelog.com/). + +## [0.1.2] - 2026-09-03 + +### Fixed +- PyPI package metadata: added `license`, `classifiers` (Python 3.9–3.12, MIT, development status), and `project_urls` (GitHub, docs site, issue tracker, changelog) to `setup.py`. Previously the PyPI page showed `License: None` and an empty classifier list, which broke the README's Python-versions badge. + +### Added +- Documentation site at [botacin-s-lab.github.io/AutoPYaraPyPI](https://botacin-s-lab.github.io/AutoPYaraPyPI/), built with MkDocs Material. +- Branch protection on `main`: pull requests with review required for everyone, enforced via a GitHub Ruleset; the release automation bypasses it using a dedicated `RELEASE_PAT`. +- `CONTRIBUTING.md` and automated PR testing (`pr-checks.yml`) — every PR against `main` now runs the full build+install+test suite. +- Two-tier release triggers: a commit subject containing "New subversion" cuts a patch release, "New version" cuts a minor release; both run the full test matrix before publishing. +- This changelog. + +## [0.1.1] - 2026-09-03 + +### Added +- First public release on PyPI. +- Bloom filter data is now downloaded from this repository's `data-branch` branch (previously an anonymous peer-review mirror). diff --git a/MANIFEST.in b/MANIFEST.in index 7514db2..6900288 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,7 @@ include README.md include RELEASING.md include CONTRIBUTING.md +include CHANGELOG.md include requirements.txt recursive-include autopyara/jars * recursive-include tests *.py diff --git a/README.md b/README.md index c6728b4..f987127 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Automatically discover malware families and generate high-quality, tightly scoped YARA rules using probabilistic clustering and Bloom-filtered n-gram analysis. -[**Documentation**](https://botacin-s-lab.github.io/AutoPYaraPyPI/) · [PyPI](https://pypi.org/project/autopyara/) · [Report a Bug](https://github.com/Botacin-s-Lab/AutoPYaraPyPI/issues) · [Releasing](RELEASING.md) +[**Documentation**](https://botacin-s-lab.github.io/AutoPYaraPyPI/) · [PyPI](https://pypi.org/project/autopyara/) · [Report a Bug](https://github.com/Botacin-s-Lab/AutoPYaraPyPI/issues) · [Changelog](CHANGELOG.md) · [Releasing](RELEASING.md)