forgejo-todo-checker/CHANGELOG.md

# Changelog

All notable changes to this project 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/spec/v2.0.0.html).

## [Unreleased]

## [1.3.1](https://git.kemitix.net/kemitix/forgejo-todo-checker/compare/v1.3.0...v1.3.1) - 2025-01-05

### Other

- *(deps)* update kemitix/forgejo-todo-checker action to v1.3.0

## [1.3.0](https://git.kemitix.net/kemitix/forgejo-todo-checker/compare/v1.2.0...v1.3.0) - 2025-01-05

### Added

- add cli args to help run locally

### Fixed

- elide lifetimes on Config
- *(deps)* update rust crate kxio to v5

### Other

- pubilsh to crates.io
- replace anyhow with color_eyre
- ignore .idea
- *(deps)* update rust crate rstest to 0.24
- *(deps)* update kemitix/rust action to v2.5.0
- *(deps)* update docker.io/rust docker tag to v1.83.0
- *(deps)* update kemitix/forgejo-todo-checker action to v1.2.0
## [1.2.0] - 2024-11-28

### Build

- *(renovate)* Ignore alias kemitix/todo-checker
- Add build steps as default recipe in justfile
- Update dogfood version from mirror to 1.1.0
- Mark untestable function to be excluded from mutation tests
- *(push-next)* Run mutation tests

### Chore

- *(deps)* Update kemitix/forgejo-todo-checker action to v1.1.0
- *(deps)* Update kemitix/rust action to v2.2.0
- *(deps)* Update rust crate rstest to 0.23
- *(deps)* Update kemitix/rust action to v2.3.0
- *(deps)* Update docker.io/rust docker tag to v1.82.0
- *(deps)* Update kemitix/rust action to v2.4.1

### Docs

- *(readme)* Add note about using the latest
- *(readme)* Fix typo about where mirror is hosted

### Feat

- Make file locations more navigable

### Fix

- *(deps)* Update rust crate file-format to 0.26
- *(deps)* Update rust crate bon to v3
- *(deps)* Update rust crate kxio to v2
- *(deps)* Update rust crate kxio to v3

## [1.1.0] - 2024-09-22

### Build

- Add justfile for self-testing
- Add test and build checks to workflows
- Use codeberg mirror to self-test todo action
- Configure release-plz
- Customise release-plz
- Drop release-plz
- Add prep-release recipe to justfile

### Chore

- Clean up output
- Release v1.1.0

### Feat

- Detect and ignore non-text files
- Log errors as they are found
- Improve error messageso

### Fix

- Only look for issue number within the comment

### Refactor

- Abstract printer via Printer trait

## [1.0.0] - 2024-09-20

### Build

- Don't check README for TODO/FIXME comments
- Use v1.0.0 of the todo checker

### Chore

- *(deps)* Update actions/checkout action to v4

### Docs

- Add instructions in README

### Feat

- Add skeleton action
- Use Dockerfile (hello world)
- List contents of current directory
- Check env vars are all set
- Collect useful environment vars
- Collect env into Config and note planned operations
- Scan for TODO and FIXME markers
- Log progress ignoring files listed in .gitignore, .ignore and .rgignore
- Pretty-print found markers
- Fetch open issues
- Flag markers where issue is closed
- Log any invalid/closed markers and exit if any found

### Fix

- Specify url correctly for action
- Specify valid value for runs.using
- Recheck tests

### Refactor

- Prepare for adding tests
- Markers as enum parsed from lines
- Comment out unused code in line
- Split up main
- Collapse empty modules
- Clean up issue regex

### Test

- Add skeleton self-test
- Allow workflow to be run manually
- Add first tests for pattern matching
- Add tests for markers

### Tests

- Add tests for Config
- Add tests for init module
- Add tests for scanner module
- Add tests for main