adamws / kicad-git

Git actions directly from KiCad's PCB editor window
GNU General Public License v3.0
17 stars 1 forks source link
action-plugin kicad pcbnew

kicad-git

KiCad Repository GitHub all releases CircleCI Coverage Status

KiCad plugin for git integration. Launch git commit graphical interface without leaving PCB editor window.

Installation

To install release version of this plugin, use KiCad's Plugin and Content Manager and select Git plugin from official plugin repository.

pcm-image

Latest master build is automatically uploaded to unofficial PCM compatible repository hosted on GitHub pages. To use it, add https://adamws.github.io/kicad-git/repository.json to PCM repository list.

[!WARNING] By default, this plugin uses git gui. On most systems it is distributed as part of the git suite. On macOS it might be required to install it separately with brew install git-gui

How to use?

Configuration

To configure different command for starting git GUI or explicitly define git executable path, create config.ini file in the plugin directory.

For example, to use TortoiseGit and non standard (not in system search PATH) git executable:

[paths]
git = C:\some\path\git.exe
git_gui = TortoiseGitProc.exe /command:commit

[!WARNING] The [paths] section in config file is required and can't be skipped.

By default, this plugin starts git gui window which will remain open after clicking 'commit' button. To start window for arranging and making exactly one commit use git citool instead:

[paths]
git = C:\some\path\git.exe
git_gui = C:\some\path\git.exe citool

[!WARNING] The citool is limited only to commits, push to remote is not supported from this view. See git manual page to learn more.

See also

:link: PCB visual diff with kicad-cli and lukaj