C++ compile-time bomb (Fails compilation after a specified date/time)
NOTE: cztodoby requires a C++20 compiler, and it has been tested with VS 2022 and clang 16.
Technical debt is inevitable, but ignoring it shouldn't be. To encourage timely action, cztodoby provides compile-time bombs: macros that fail compilation after a specified date and time. These serve as helpful reminders for tasks or deadlines, ensuring important updates aren't overlooked.
With cztodoby, you can embed deadlines directly into your code. Once the compilation timestamp exceeds the specified timestamp, compilation will fail. This is perfect for teams looking to set deadlines for code reviews, updates, or even personal reminders.
E.g:
// Trying to compile after Dec 9th, 2024, at 4pm, will fail.
CZ_COMPILE_TIMEBOMB("Dec 09 2024 16:00:00", "Implement this function before finishing for the day.");If you don't want a custom message you can simply use:
CZ_TODO_BY("Dec 09 2024 16:00:00");If the time is not specified, it assumes 00:00:00:
CZ_TODO_BY("Dec 09 2024"); // Fails as once the clock turns Dec 9th, 2024.- Triggered only during compilation:
- Compile-time bombs activate when the code is compiled. If the file containing the macro is not recompiled (e.g., due to incremental builds), the bomb will not trigger until a full rebuild.
- Local vs CI Builds:
- Local development: Incremental builds may delay the trigger until you modify the file or do a full rebuild.
- Automated builds (e.g., CI/CD) : Systems like GitHub Actions or other CI pipelines typically perform full rebuilds, ensuring that time bombs are checked regularly.
- Ensure your project uses C++20 or higher.
- Include the
TodoBy.hheader in your code.- If you prefer to use cmake, the included script defines the
cztodobytarget that you can use.
- If you prefer to use cmake, the included script defines the
- Use the provided macros (
CZ_COMPILE_TIMEBOMBorCZ_TODO_BY) where needed.
Depending on your team's preferences, you might want time bombs to trigger only for specific build types.
By default, they are enabled for all builds. To disable them for certain builds, define the CZTODOBY_ENABLED macro as 0 in the corresponding build configuration(s).
If timebombs end up being too annoying for the rest of the team, you can instead set time bombs that only trigger for a specific developer.
The macros ending in _USER (e.g CZ_TODO_BY_USER) allow specifying the user the time bomb applies to.
This is implemented by having the CMakeLists.txt retrieve the username from the environment variables and setting a CZTODOBY_USER define.
This is then used to compare against the username provided by the time bomb.
Example:
// Only triggers when it's me (Rui) building the code
CZ_TODO_BY_USER("Rui", "Jan 01 2025");