sequenceeditor: reword comment about `oid_to_paths` cache
[git-cola.git] / garden.yaml
bloba5e4417f300c7a540d3d34d7532aebd48eaf2d74
1 # Use "cargo install garden-tools" to install garden https://gitlab.com/garden-rs/garden
3 #   # Installation
4 #   garden install              # Install git-cola to the installation ${prefix}
5 #   garden doc                  # Generate documentation: html + manual pages
6 #   garden install docs         # Install documentation
8 #   # Variables can be overridden using "-D name=value", e.g.:
9 #   garden -D prefix=$PWD/dist install docs
10 #   garden -D DESTDIR=/tmp/stage -D prefix=/usr/local install
12 #   # Development
13 #   garden test                 # Run the test suite
14 #   garden fmt                  # Format code using "cercis"
15 #   garden html                 # Generate documentation: html only
16 #   garden man                  # Generate documentation: manual pages only
17 #   garden pot                  # Regenerate git-cola.pot with new translations
18 #   garden po                   # Update .po files with new translations from git-cola.pot
19 #   garden pages                # Install the pages/ website documentation.
21 #   # macOS
22 #   garden macos/app            # Build a git-cola.app bundle
24 #   # Related Projects
25 #   garden grow pages           # Clone the Git Cola homepage
26 #   garden grow fedora          # Clone the Fedora packaging
27 #   garden grow deb             # Clone the Debian packaging
28 trees:
29   git-cola:
30     description: The highly-caffeinated Git GUI
31     path: "${GARDEN_CONFIG_DIR}"
32     url: "git@gitlab.com:git-cola/git-cola.git"
33     commands:
34       doc: ${GARDEN} -vv cmd docs html man -- "$@"
35       dev: ${PYTHON} -m venv --system-site-packages ${env_dir}
36       dev>:
37         - dev/extras
38         - dev/development
39         - dev/build
40       dev/build: ${activate} ${PIP} install --editable '.[build]'
41       dev/development: ${activate} ${PIP} install --editable '.[docs,dev]'
42       dev/extras: ${activate} ${PIP} install --editable '.[extras]'
43       dev/pyqt6: ${activate} ${PIP} install --editable '.[pyqt6]'
44       dev/env: ${activate} "$@"
45       check>:
46         - test
47         - doc
48         - pylint
49       fmt: |
50         ${activate}
51         ${CERCIS} --version
52         ${GIT} ls-files -- '*.py' |
53         ${GREP} -v ^qtpy |
54         ${XARGS} ${CERCIS} "$@"
55       html: ${GARDEN} -vv html docs
56       install: |
57         if test -n "${DESTDIR}"
58         then
59             pip_root="--root=${DESTDIR}"
60             export DESTDIR="${DESTDIR}"
61         fi
62         ${PIP} install --disable-pip-version-check $pip_root --prefix=${prefix} "$@" .
63       i18n>:
64         - pot
65         - po
66       macos/app: |
67         ${MKDIR_P} ${cola_app}/Contents/MacOS
68         ${MKDIR_P} ${cola_app_resources}
69         ${PYTHON} -m venv ${cola_app_resources}
70         source ${cola_app_resources}/bin/activate
71         ${PIP} install '.[docs,extras,pyqt6]'
72         ${CP} contrib/darwin/Info.plist contrib/darwin/PkgInfo ${cola_app}/Contents
73         if test -n "${cola_full_version}"
74         then
75             ${SED} -i -e s/0.0.0.0/${cola_full_version}/ ${cola_app}/Contents/Info.plist
76         fi
77         ${SED} -i -e s/0.0.0/${cola_version}/ ${cola_app}/Contents/Info.plist
78         ${CP} contrib/darwin/git-cola ${cola_app}/Contents/MacOS
79         ${CP} contrib/darwin/git-cola.icns ${cola_app}/Contents/Resources
80         ${GARDEN} -vv -D prefix=${cola_app_resources} install
81         ${GARDEN} -vv doc
82         ${GARDEN} -vv -D prefix=${cola_app_resources} install docs
83       man: ${GARDEN} -vv man docs
84       po: |
85         for po in cola/i18n/*.po
86         do
87             ${MSGMERGE} \
88                 --no-wrap \
89                 --no-fuzzy-matching \
90                 --sort-output \
91                 --output-file $$po.new \
92                 $$po \
93                 cola/i18n/git-cola.pot
94             mv $$po.new $$po
95         done
96       pot: |
97         ${XGETTEXT} \
98             --language=Python \
99             --keyword=N_ \
100             --no-wrap \
101             --omit-header \
102             --sort-output \
103             --output-dir cola/i18n \
104             --output git-cola.pot \
105             cola/*.py \
106             cola/*/*.py
107       pages<: doc
108       pages: ${GARDEN} -vv -D prefix=${TREE_PATH}/pages install docs "$@"
109       pylint: |
110         ${PYLINT} --version
111         ${PYLINT} ${PYLINT_OPTIONS} --rcfile=.pylintrc "$@" cola test
112       run: ${activate} ./bin/git-cola "$@"
113       run/qt6: ${activate} QT_API=PyQt6 ./bin/git-cola "$@"
114       test: ${activate} ${PYTEST_CMD} cola test "$@"
115       tox: ${TOX} run "$@"
116       tox/check: ${TOX} run -e check "$@"
117     gitconfig:
118       remote.publish.pushurl:
119         - "git@gitlab.com:git-cola/git-cola.git"
120         - "git@github.com:git-cola/git-cola.git"
121     remotes:
122       BaumiCoder: "https://github.com/BaumiCoder/git-cola.git"
123       DasaniT: "https://github.com/DasaniT/git-cola.git"
124       Mailaender: "https://github.com/Mailaender/git-cola.git"
125       Mithil467: "https://github.com/Mithil467/git-cola.git"
126       NielBuys: "https://github.com/NielBuys/git-cola.git"
127       WNguyen14: "https://github.com/WNguyen14/git-cola.git"
128       abid1998: "https://github.com/abid1998/git-cola.git"
129       achernet: "https://github.com/achernet/git-cola.git"
130       axel-h: "https://github.com/axel-h/git-cola.git"
131       bearsh: "https://github.com/bearsh/git-cola.git"
132       bensmrs: "https://github.com/bensmrs/git-cola.git"
133       bobvanderlinden: "https://github.com/bobvanderlinden/git-cola.git"
134       brccabral: "https://github.com/brccabral/git-cola.git"
135       davvid: "git@github.com:davvid/git-cola.git"
136       dschwoerer: "https://github.com/dschwoerer/git-cola.git"
137       florisla: "https://github.com/florisla/git-cola.git"
138       fu7mu4: "https://github.com/fu7mu4/git-cola.git"
139       gdebure: "https://github.com/gdebure/git-cola.git"
140       github: "git@github.com:git-cola/git-cola.git"
141       guoyunhe: "https://github.com/guoyunhe/git-cola.git"
142       gyuris: "https://github.com/gyuris/git-cola.git"
143       haffmans: "https://github.com/haffmans/git-cola.git"
144       harmathy: "https://github.com/harmathy/git-cola.git"
145       hsoft: "https://github.com/hsoft/git-cola.git"
146       jamie-pate: "https://github.com/jamie-pate/git-cola.git"
147       kenyuy: "https://github.com/kenyuy/git-cola.git"
148       kisaragi-hiu: "https://github.com/kisaragi-hiu/git-cola.git"
149       kneirinck: "https://github.com/kneirinck/git-cola.git"
150       kurtmckee: "https://github.com/kurtmckee/git-cola.git"
151       laerreal: "https://github.com/laerreal/git-cola.git"
152       lah7: "https://github.com/lah7/git-cola.git"
153       living180: "https://github.com/living180/git-cola.git"
154       ljhcage: "https://github.com/ljhcage/git-cola.git"
155       malpas: "https://github.com/malpas/git-cola.git"
156       melkecelioglu: "https://github.com/melkecelioglu/git-cola.git"
157       milestone12: "https://github.com/milestone12/git-cola.git"
158       mmargoliono: "https://github.com/mmargoliono/git-cola"
159       mp-chet: "https://github.com/mp-chet/git-cola.git"
160       nakanoi: "https://github.com/nakanoi/git-cola.git"
161       nandalopes: "https://github.com/nandalopes/git-cola.git"
162       OriShalhon: "https://github.com/OriShalhon/git-cola.git"
163       pilarmolinalopez: "https://github.com/pilarmolinalopez/git-cola.git"
164       quintusfelix: "https://github.com/quintusfelix/git-cola.git"
165       rafaelreuber: "https://github.com/rafaelreuber/git-cola.git"
166       scop: "https://github.com/scop/git-cola.git"
167       sergei-dyshel: "https://github.com/sergei-dyshel/git-cola.git"
168       sthalik: "https://github.com/sthalik/git-cola.git"
169       skunkwerks: "https://github.com/skunkwerks/git-cola.git"
170       takluyver: "https://github.com/takluyver/git-cola.git"
171       thk123: "https://github.com/thk123/git-cola.git"
172       timgates42: "https://github.com/timgates42/git-cola.git"
173       vdragon: "https://github.com/Vdragon/git-cola.git"
174       victorhck: "https://github.com/victorhck/git-cola.git"
175       virtualstaticvoid: "https://github.com/virtualstaticvoid/git-cola.git"
176       wm4: "https://github.com/wm4/git-cola.git"
177       wojnilowicz: "https://github.com/wojnilowicz/git-cola.git"
178       yaellevy: "https://github.com/yaellevy/git-cola.git"
179   deb:
180     description: Debian packaging
181     url: "git@gitlab.com:git-cola/git-cola-debian.git"
182     remotes:
183       davvid: "git@github.com:davvid/git-cola-debian.git"
184   docs:
185     description: Sphinx documentation
186     variables:
187       env_dir: ../env3
188     commands:
189       clean: rm -fr _build
190       doctest: ${activate} ${SPHINX_CMD} -b doctest . _build/doctest "$@"
191       html: ${activate} ${SPHINX_CMD} -b html . _build/html "$@"
192       man: ${activate} ${SPHINX_CMD} -b man . _build/man "$@"
193       linkcheck: ${activate} ${SPHINX_CMD} -b linkcheck . _build/linkcheck "$@"
194       install: |
195         ${MKDIR_P} ${DESTDIR}${docdir}
196         ${INSTALL} -m 644 *.html ${DESTDIR}${docdir}
197         ${INSTALL} -m 644 *.rst ${DESTDIR}${docdir}
198         # HTML documentation
199         ${MKDIR_P} ${DESTDIR}${htmldir}
200         ${RSYNC_CMD} _build/html/ ${DESTDIR}${htmldir}/
201         # Manual pages
202         ${MKDIR_P} ${DESTDIR}${mandir}
203         ${INSTALL} -m 644 _build/man/git-cola.1 ${DESTDIR}${mandir}
204         ${INSTALL} -m 644 _build/man/git-dag.1 ${DESTDIR}${mandir}
205   fedora:
206     description: Fedora packaging
207     url: "https://src.fedoraproject.org/rpms/git-cola.git"
208     remotes:
209       git-cola: "git@gitlab.com:git-cola/git-cola-fedora.git"
210       davvid: "git@github.com:davvid/git-cola-fedora.git"
211   pages:
212     description: "Git Cola's homepage"
213     url: "git@gitlab.com:git-cola/git-cola.gitlab.io.git"
214     remotes:
215       github: "git@github.com:git-cola/git-cola.github.io.git"
216       ls-jad-elkik: "git://github.com/ls-jad-elkik/git-cola.github.io.git"
217       lz-coder: "https://github.com/lz-coder/git-cola.github.io.git"
218     gitconfig:
219       remote.origin.pushurl:
220         - "git@gitlab.com:git-cola/git-cola.gitlab.io.git"
221         - "git@github.com:git-cola/git-cola.github.io.git"
222     commands:
223       build: ${JEKYLL} build --destination build "$@"
224     links:
225       - "https://git-cola.gitlab.io"
226       - "https://git-cola.github.io"
228 commands:
229   commit: git commit "$@"
230   diff: git diff "$@"
231   diffs: git diff --staged "$@"
232   fetch: git fetch "$@"
233   stat: git status --short "$@"
234   status: git status "$@"
235   stage: git add -u "$@"
236   push: git push "$@"
237   pull: git pull --ff-only "$@"
239 # Variables can be overridden externally using "garden -D name=value ...".
240 variables:
241   # Traditional DESTDIR + prefix variables
242   DESTDIR: ""
243   prefix: ${GARDEN_CONFIG_DIR}/dist
244   docdir: ${prefix}/share/doc/git-cola
245   htmldir: ${docdir}/html
246   mandir: ${prefix}/share/man/man1
247   cola_app: ${TREE_PATH}/git-cola.app
248   cola_app_resources: ${cola_app}/Contents/Resources
249   cola_full_version: $ ./bin/git-cola version --brief
250   cola_version: $ ${SED} -e "s/VERSION = '\(.*\)'/\1/"  cola/_version.py
251   is_virtualenv: |
252     $ ${PYTHON} -c '
253     import os, sys
254     if sys.prefix != sys.base_prefix or os.environ.get("VIRTUAL_ENV"):
255         print("true")
256     '
257   env_dir: env3
258   activate: |
259     if test -z "${is_virtualenv}" && test -f "${env_dir}/bin/activate"
260     then
261         source "${env_dir}/bin/activate"
262     fi
263   # External commands and options
264   CERCIS: cercis
265   CP: cp
266   GARDEN: garden
267   GIT: git
268   GREP: grep
269   INSTALL: install
270   JEKYLL: jekyll
271   MKDIR_P: mkdir -p
272   MSGMERGE: msgmerge
273   PIP: pip
274   PYLINT: ${activate} ${PYTHON} -B -m pylint
275   PYLINT_OPTIONS: |
276     $ ${activate} ${PYLINT} --score=no --help >/dev/null 2>&1 && printf '%s' --score=no
277   PYTEST: ${activate} ${PYTHON} -B -m pytest
278   PYTEST_OPTIONS: $ test "$(uname -s)" != "Linux" && printf '%s' --ignore=cola/inotify.py
279   PYTEST_CMD: ${PYTEST} ${PYTEST_OPTIONS} -p no:cacheprovider
280   PYTHON: python3
281   RSYNC: rsync
282   RSYNC_CMD: ${RSYNC} -r --delete --exclude=.buildinfo
283   SED: sed
284   SPHINX: ${PYTHON} -m sphinx
285   SPHINX_CMD: ${SPHINX} -d _build/doctrees -a
286   TOX: tox
287   XARGS: xargs
288   XGETTEXT: xgettext