check-oldies is a collection of programs that warn about old things in code:
check-fixmes warns about old FIXME or TODO annotations.
If we did not regularly check, we would forget about that FIXME note we wrote a few months ago. check-fixmes warns us about it. It is then our choice to act: fix it, remove it (because we decided it is not worth to fix, or because it is not relevant anymore), or postpone it.
check-future-tags warns about orphan FUTURE tags.
We sometimes plan a broad modification that will span multiple files. Instead of littering FIXME annotations everywhere, we set a single FIXME annotation and a FUTURE-xxx tag on the same line. Then, wherever we need to make a modification, we only mention this FUTURE-xxx tag without any FIXME. If we ever remove the FIXME but keep a FUTURE-xxx tag somewhere, it is a mistake and this tool warns us. (See documentation <https://check-oldies.readthedocs.io/en/latest/check_future_tags.html> for an example.)
check-branches warns about old branches, surprisingly.
forget-me-not runs both programs above on a set of Git repositories and sends warning e-mails to authors of soon-to-be-old annotations or branches.
In other words: check-fixmes, check-branches and check-future-tags can be run as part of the test suite of each project (by a continuous integration system such as Jenkins). They break builds when they detect old things. On the other hand, forget-me-not can be run once a week on a set of projects to warn authors that some builds will break soon if they do not take care of their old annotations or branches.
Example output
$ check-fixmes NOK: Some annotations are too old, or there are orphan FUTURE tags. jdoe - 181 days - frobulator/api.py:12: # FIXME (jdoe): we should catch errors jdoe - 100 days - frobulator/api.py:25: # TODO: this is slow, use the batch API instead jsmith - 12 days - docs/index.rst:1: # FIXME: write documentation before open sourcing
$ check-branches NOK: Some branches are too old. john.smith@example.com - 92 days - jsmith/fix_frobs (https://github.com/Polyconseil/check-oldies/tree/jsmith/fix_frobs), linked to open PR/MR #1 (https://github.com/Polyconseil/check-oldies/pull/1)
Applicability
check-oldies is written in Python but is language-agnostic. It works on Git repositories but could be extended to other version control systems. It integrates with GitHub and GitLab but can do without it, and could be extended to work with other code hosting platforms.
Requirements and installation
You must have Python 3.10 or later, and Git 2.19.0 or later.
Install with pip, preferably in a virtual environment:
$ python3 -m venv /path/to/your/virtualenv
$ source /path/to/your/virtualenv/bin/activate
$ pip install check-oldiesFeatures, configuration and more
The full documentation has more details about the features and the configuration, examples of the usage of FUTURE tags, how to contribute, etc.
3 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file check_oldies-1.0.1.tar.gz.
File metadata
- Download URL: check_oldies-1.0.1.tar.gz
- Upload date:
- Size: 39.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c8054005517566aeb72bdfa35969943bdb9c2d3ff621df94e767646dfc89154a
|
|
| MD5 |
f38b93957539a830088d03659a4a92ef
|
|
| BLAKE2b-256 |
f5e6b68be57513df47086adbf58133bf6490e5db049c390926cddcbacdfa7a78
|
Provenance
The following attestation bundles were made for check_oldies-1.0.1.tar.gz:
Publisher:
publish-on-pypi.yaml on Polyconseil/check-oldies
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
check_oldies-1.0.1.tar.gz -
Subject digest:
c8054005517566aeb72bdfa35969943bdb9c2d3ff621df94e767646dfc89154a - Sigstore transparency entry: 2282397343
- Sigstore integration time:
-
Permalink:
Polyconseil/check-oldies@21efe4d84509bc9dbff75c6c261bfb5683d28dd3 -
Branch / Tag:
refs/tags/1.0.1 - Owner: https://github.com/Polyconseil
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-on-pypi.yaml@21efe4d84509bc9dbff75c6c261bfb5683d28dd3 -
Trigger Event:
push
-
Statement type:
File details
Details for the file check_oldies-1.0.1-py3-none-any.whl.
File metadata
- Download URL: check_oldies-1.0.1-py3-none-any.whl
- Upload date:
- Size: 21.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2ef811b1d0b2c6e994dfca59384e68eb354b96f4e75d312a0f846b44c753936d
|
|
| MD5 |
b4b7b62ab10eba13f418d0973fa31646
|
|
| BLAKE2b-256 |
220ea74592b56fd207a499df9c74964c0ae95f16a84097edc37f64343bfa8dc4
|
Provenance
The following attestation bundles were made for check_oldies-1.0.1-py3-none-any.whl:
Publisher:
publish-on-pypi.yaml on Polyconseil/check-oldies
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
check_oldies-1.0.1-py3-none-any.whl -
Subject digest:
2ef811b1d0b2c6e994dfca59384e68eb354b96f4e75d312a0f846b44c753936d - Sigstore transparency entry: 2282397427
- Sigstore integration time:
-
Permalink:
Polyconseil/check-oldies@21efe4d84509bc9dbff75c6c261bfb5683d28dd3 -
Branch / Tag:
refs/tags/1.0.1 - Owner: https://github.com/Polyconseil
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-on-pypi.yaml@21efe4d84509bc9dbff75c6c261bfb5683d28dd3 -
Trigger Event:
push
-
Statement type:
