Skip to content

Commit 475cc1c

Browse files
committed
fix: documentation improvements
* Compile error trying to use `yara` feature on unsupported architecture. Signed-off-by: Richard Zak <richard.j.zak@gmail.com>
1 parent b3dab5a commit 475cc1c

File tree

6 files changed

+46
-10
lines changed

6 files changed

+46
-10
lines changed

Cargo.toml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,16 @@ homepage = "https://malwaredb.net/"
100100
keywords = ["cybersecurity", "malware", "malware-research", "forensics"]
101101
categories = ["database", "data-structures", "parsing"]
102102
rust-version = "1.88.0"
103-
publish = false
103+
# Ensure the change logs are updated before publishing.
104+
# Ensure the versions below are updated.
105+
publish = true
104106

105107
[workspace.dependencies]
106108
# Internal dependencies
107-
malwaredb-api = { path = "crates/api", version = "0.3.0", default-features = false }
108-
malwaredb-client = { path = "client", version = "0.3.0", default-features = false }
109-
malwaredb-server = { path = "crates/server", version = "0.3.0", default-features = false }
110-
malwaredb-types = { path = "crates/types", version = "0.3.0", default-features = false }
109+
malwaredb-api = { path = "crates/api", version = "0.3.1", default-features = false }
110+
malwaredb-client = { path = "client", version = "0.3.1", default-features = false }
111+
malwaredb-server = { path = "crates/server", version = "0.3.1", default-features = false }
112+
malwaredb-types = { path = "crates/types", version = "0.3.1", default-features = false }
111113

112114
# External dependencies
113115
aes-gcm = { version = "0.10.3", default-features = false }

client/debian/changelog

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
1-
malwaredb-client (0.2.3-1) unreleased; urgency=low
1+
malwaredb-client (0.3.1-1) unstable; urgency=low
2+
3+
* Fix mDNS advertisements.
4+
* Fix documentation.
5+
6+
-- Richard Zak <richard.j.zak@gmail.com> Mon, 02 Feb 2026 22:36:00 -0400
7+
8+
malwaredb-client (0.3.0-1) unstable; urgency=low
29

310
* Search with Yara rules.
411
* Dependency updates.
512

6-
-- Richard Zak <richard.j.zak@gmail.com> Wed, 31 Dec 2025 12:00:00 -0400
13+
-- Richard Zak <richard.j.zak@gmail.com> Sat, 31 Jan 2026 13:23:00 -0400
714

815
malwaredb-client (0.2.2-1) unstable; urgency=low
916

crates/server/src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ pub mod utils;
2424
pub mod vt;
2525

2626
/// Yara-related functionality
27+
#[cfg_attr(docsrs, doc(cfg(feature = "yara")))]
2728
#[cfg(feature = "yara")]
2829
pub mod yara;
2930

crates/server/src/yara.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ use uuid::Uuid;
77
use yara_x::errors::CompileError;
88
use yara_x::{Compiler, Rules};
99

10+
#[cfg(not(any(
11+
target_arch = "aarch64",
12+
target_arch = "riscv64",
13+
target_arch = "s390x",
14+
target_arch = "x86_64"
15+
)))]
16+
compile_error!("Compile error: Yara not supported on this architecture.");
17+
1018
pub(crate) const MAX_YARA_PROCESSES: usize = 4;
1119

1220
/// Yara task information to find matching files

debian/changelog

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
1-
malwaredb (0.2.3-1) unreleased; urgency=low
1+
malwaredb (0.3.1-1) unstable; urgency=low
2+
3+
* Fix mDNS advertisements.
4+
* Fix database migration.
5+
* Fix documentation.
6+
7+
-- Richard Zak <richard.j.zak@gmail.com> Mon, 02 Feb 2026 22:36:00 -0400
8+
9+
malwaredb (0.3.0-1) unstable; urgency=low
210

311
* Search with Yara rules.
412
* Logging to systemd journald.
13+
* Change database field types to `bytea` for hashes (`uuid` for MD5).
14+
* Database migration admin feature.
515
* Dependency updates.
616

7-
-- Richard Zak <richard.j.zak@gmail.com> Wed, 31 Dec 2025 12:00:00 -0400
17+
-- Richard Zak <richard.j.zak@gmail.com> Sat, 31 Jan 2026 13:23:00 -0400
818

919
malwaredb (0.2.2-1) unstable; urgency=low
1020

log.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
## Unreleased
1+
## Version v0.3.1
2+
02 February 2026
3+
4+
### 01 February 2026
5+
* Fix mDNS advertisements.
6+
* Fix database migration.
7+
8+
## Version v0.3.0
9+
31 January 2026
210

311
### 17 January 2026
412
* Search with Yara rules.

0 commit comments

Comments
 (0)