Skip to content

Commit

Permalink
docs: Update CHANGELOG
Browse files Browse the repository at this point in the history
Remove ReleaseNotes and use CHANGELOG instead.
  • Loading branch information
carloslack committed Dec 17, 2024
1 parent e901d15 commit 8c82cc6
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 15 deletions.
22 changes: 16 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 0 additions & 6 deletions docs/ReleaseNotes.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/ReleaseProcess.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 8c82cc6

Please sign in to comment.