Skip to content

Commit dd6a57c

Browse files
committed
Update CHANGELOG.md & README.md
1 parent 53eb1fa commit dd6a57c

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212

1313
## [0.2.4] - 2025-09-28
1414

15+
### Added
16+
17+
- GitHub action `audit.yml`, with `audit-check` and `cargo-deny-action` actions
18+
- `audit.toml` for local and CI `cargo audit` configuration
19+
- `deny.toml` for local and CI `cargo deny` configuration
20+
- Pre-commit hook, `.pre-commit-config.yaml`
21+
1522
### Changed
1623
- Updated several dependencies to newer versions.
1724
- `cargo audit` found a security vulnerability in a dependency (that version has been yanked).

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,28 @@ The file paths in the examples are for Windows.
6666
- Also tested on WSL - Ubuntu 22.04.2 LTS (GNU/Linux 5.15.133.1-microsoft-standard-WSL2 x86_64) on Windows 11 @ x86-64.
6767
- Linux wasn't tested directly, but should work, at least on x86-64 CPUs.
6868

69+
## Security
70+
71+
- [cargo audit](https://github.com/rustsec/rustsec/blob/main/cargo-audit/README.md) is supported,
72+
as well as its GitHub action, [audit-check](https://github.com/rustsec/audit-check).
73+
- [cargo deny](https://embarkstudios.github.io/cargo-deny/) is supported,
74+
as well as its GitHub action, [cargo-deny-action](https://github.com/EmbarkStudios/cargo-deny-action).
75+
76+
## Development
77+
78+
### Pre-commit
79+
80+
[pre-commit](https://pre-commit.com/) hooks are supported.
81+
82+
```shell
83+
$ pip install pre-commit
84+
$ pre-commit install
85+
$ pre-commit run # For manual running; considers only modified files
86+
$ pre-commit run --all-files # For manual running; considers all files
87+
```
88+
89+
After installing it, the provided [pre-commit hook](.pre-commit-config.yaml) will run automatically on `git commit`.
90+
6991
## Running the Application
7092
Executable files for Windows, macOS and Linux can be downloaded from
7193
the [Releases](https://github.com/ivanbgd/reduce-image-size-rust/releases) page of the repository.

0 commit comments

Comments
 (0)