How to fork ActivityWatch, the right way.
This document is intended for people who want to fork ActivityWatch and make changes to it. It is not intended for people who want to contribute to the main ActivityWatch project.
ActivityWatch is licensed under the Mozilla Public License v2 (MPLv2), which means (simplified):
You can fork it, make changes to it, and distribute it under the same license.
You must publish changes you make to the source code (if you intend to distribute it)
You must not use the name “ActivityWatch” for your fork
You must not use the ActivityWatch logo for your fork
You must clearly mention that your fork is a fork of ActivityWatch, and that it is not otherwise affiliated with the main ActivityWatch project
TL;DR: Forking is fine, but if you intend to distribute your fork, please don’t use the name “ActivityWatch”.
Working with a fork¶
When forking the main ActivityWatch repo, you will notice that it uses git submodules for each of the modules. You therefore need to also fork the individual modules you wish to modify, and retarget the
git submodule to use your forked repo.
To minimize the headache of keeping your fork up to date with the main repo, we recommend you submit as many generally-useful PRs to the main ActivityWatch project as possible, then rebase or merge in upstream changes onto your fork.
Building on macOS¶
When building for macOS there are a few extra considerations, as ActivityWatch requires access to APIs that can cause great trouble for unsigned applications.
To get a working build you need to sign the application with a developer certificate. This requires a paid Apple Developer ID, which costs $99/year.
Once you’ve created a certificate, you need to set the necessary keys and certificate in your CI secrets. You can find the relevant secrets needed here.
Updating media files¶
All logo files reside in the media repo, which is a submodule to several repos like aw-qt and aw-webui. To change the logo, fork the
media repo and update the appropriate submodules to use your fork.
Examples of forks¶
These are just to serve as reference, and to keep track of forks.
If you fork ActivityWatch, please add your fork to this list.