Files
stopwatch/README.md
T
Claude 626db60658 Timer safety: length limit, server-side saving, stop on close
- Maximum timer length setting (default 10h): a timer that runs past it
  is stopped at the limit and its entry's comment is flagged, so a
  forgotten timer can't add a night or weekend of hours
- StopwatchTimerTickJob saves a running timer's time every minute on the
  server (no browser needed) and stops it at the limit on time; open
  tabs keep saving too
- Timer updates lock the user's preference row and re-read the timer, so
  simultaneous saves (several tabs, the job) never add time twice
- Closing an issue stops timers running on it before anything else (e.g.
  billing) uses its time; deleting a time entry only stops the timer
  running on that entry
- Issue timers require a visible issue; starting again moves the timer
  instead of raising "timer is already running"
- Tests updated and extended (limit, locking, tick job, close, delete,
  visibility, issue context menu); CI runs on Redmine 7.0
- Upstream's German notes translated

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-29 00:13:21 -04:00

66 lines
3.3 KiB
Markdown

# Stopwatch Plugin for Redmine [![Test with Redmine](https://github.com/jkraemer/stopwatch/actions/workflows/redmine.yml/badge.svg)](https://github.com/jkraemer/stopwatch/actions/workflows/redmine.yml)
Minimal plugin that aims to make tracking your time with Redmine much easier.
## Features
- Adds a **Log time** menu item to the account menu (top right)
- That link leads to an overlay listing today's time entries, with a form that
allows editing existing or creating a new entry.
- Time entries can be started / stopped from the overlay as well as via their
context menu. There can only be one currently running entry, which will be
periodically updated with the time lapsed since it was started. Previously
running entry is stopped automatically when another is started.
- The hours:minutes of the currently *running* entry is highlighted in time
entry listings as well as shown next to the **Log time** menu item as well as
in the window title.
- Creating an entry with 0 minutes saves it in *running* state.
![Screenshot](https://github.com/jkraemer/stopwatch/raw/screenshots/img/screenshot.png)
## Changes in this fork
This is a fork of [jkraemer/stopwatch](https://github.com/jkraemer/stopwatch), modified by
Rick Barrette (2026):
- **Redmine 7:** requires Redmine 7.0+. The issue context-menu Start/Stop entry now uses Redmine 7's
`view_issues_context_menu_start` hook instead of patching `ContextMenusController` (July 2026).
- **Colour-coded Start/Stop:** an optional setting ("Color-code Start/Stop") shows the issue Start
link in green and Stop in red, with tinted buttons on mobile (March 2026; colours adjusted for
readable contrast in October 2026).
- **Timer safety (October 2026):**
- *Maximum timer length* setting (default 10 hours): a forgotten timer is stopped at the limit and
its time entry's comment is flagged, instead of adding a night or weekend of hours.
- Running timers are saved every minute on the server (a background job), so issues show the time
live even with no browser open; open tabs keep saving too. Saves lock the timer, so several tabs
can't add the same time twice.
- Closing an issue stops any timer running on it first, so the logged time is final (e.g. before
billing). Deleting a time entry only stops the timer if it runs on that entry.
- Issue timers require an issue the user can see; starting twice moves the timer instead of
erroring.
- Tests run against Redmine 7.0.
## Installation
Add the plugin to your Redmine installation's `plugins` folder, run `bundle
install` and restart Redmine. No database migrations necessary.
## License
Copyright (C) 2020 [Jens Krämer](https://jkraemer.net)
The Stopwatch plugin for Redmine is free software: you can redistribute
it and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
The Stopwatch plugin for Redmine is distributed in the hope that it
will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.
You should have received a copy of the GNU General Public License along with
the plugin. If not, see [www.gnu.org/licenses](https://www.gnu.org/licenses/).