From 8c82cc612404ad437e2d07692edaa121a44e6464 Mon Sep 17 00:00:00 2001 From: chash Date: Tue, 17 Dec 2024 09:43:12 +0000 Subject: [PATCH] docs: Update CHANGELOG Remove ReleaseNotes and use CHANGELOG instead. --- CHANGELOG.md | 22 ++++++++++++++++------ docs/ReleaseNotes.md | 6 ------ docs/ReleaseProcess.md | 6 +++--- 3 files changed, 19 insertions(+), 15 deletions(-) delete mode 100644 docs/ReleaseNotes.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f6f247..0aa66ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,12 +5,22 @@ All notable changes to KoviD 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/). ## Unreleased -- `/proc` UI re-worked with `match_table` -- `/proc` UI visibility handled by `statx` -- Key is required for back-door connections -- Add how-to-write-test doc -- Add KoviD initial regression tests: back-doors, hide processes, module and more. -- Add `cmake` build system for tests framework +### Fixed +- test: False positive for `BUG: unable to handle page fault` related to `llvm.lit` test runner + +### Changed +- protect, with encryption, memory stored back-door Key +- proc UI re-designed +- black-list proc UI from directory stats + +### Added +- Feature: tamper stat's counter (`Links:`) for hidden hard-links +- Feature: basic encryption +- Tools: x86-64 lkm loader under `inject/` +- Tests: `ftrace`, back-doors, `proc`, `Kaudit` +- Tests: KoviD initial regression tests: back-doors, hide processes, module +- Tests:`cmake` build system for tests framework +- Tests: Native tests ## 2.1.1 - Oct 19 2024 ### Fixed diff --git a/docs/ReleaseNotes.md b/docs/ReleaseNotes.md deleted file mode 100644 index 4bcdd02..0000000 --- a/docs/ReleaseNotes.md +++ /dev/null @@ -1,6 +0,0 @@ -# Release Notes - -### 2.0.0 - -1. Item 1 -2. Item 2 diff --git a/docs/ReleaseProcess.md b/docs/ReleaseProcess.md index ed34334..f0c65e8 100644 --- a/docs/ReleaseProcess.md +++ b/docs/ReleaseProcess.md @@ -14,8 +14,8 @@ This document outlines the steps required to prepare, validate, and publish a ne 1. Determine the next release version according to the versioning policy. 2. Update the version number. -### 2. Update Release Notes -1. Open `docs/ReleaseNotes.md`. +### 2. Update Changelog +1. Open `CHANGELOG.md`. 2. Add a summary of changes, including new features, bug fixes, and any known issues since the last release. 3. Ensure notes are clear, accurate, and helpful. @@ -85,7 +85,7 @@ Replace vX.Y.Z with your new version. 1. Create a new release on GitHub. 2. Use the newly created tag. -3. Include ReleaseNotes.md content in the release description. +3. Include CHANGELOG.md content in the release description. 4. Optionally attach binary. ### 8. Announcement (Optional)