| blob | 97b11d39a487c90bcc60bc90454c80fbf7d201c8 |
1 # Use "cargo install garden-tools" to install garden https://gitlab.com/garden-rs/garden
2 #
3 # Usage:
4 #
5 # # Development Workflows
6 # garden develop # Runs "pip install --editable ."
7 # garden requirements # Install runtime requirements
8 # garden requirements/opt # Install optional runtime requirements
9 # garden requirements/dev # Install developer requirements
10 # garden test # Run the test suite
11 # garden fmt # Format code using "cercis"
12 # garden doc # Generate documentation: html + manual pages
13 # garden html # Generate documentation: html only
14 # garden man # Generate documentation: manual pages only
15 # garden pot # Regenerate git-cola.pot with new translations
16 # garden po # Update .po files with new translations from git-cola.pot
17 # garden pages # Install the pages/ website documentation.
18 #
19 # # Installation
20 # garden install # Install git-cola to the installation ${prefix}
21 # garden install docs # Install documentation
22 #
23 # # Variables can be overridden using "-D name=value", eg:
24 # garden -D DESTDIR=/tmp/stage -D prefix=/usr/local install
25 # garden -D prefix=$PWD/dist install docs
26 #
27 # # macOS
28 # garden macos/app # Build a git-cola.app bundle
29 #
30 # # Related Projects
31 # garden grow pages # Clone the Git Cola homepage
32 # garden grow fedora # Clone the Fedora packaging
33 # garden grow deb # Clone the Debian packaging
34 ---
35 garden:
36 root: "${GARDEN_CONFIG_DIR}"
38 trees:
39 git-cola:
40 path: "${GARDEN_CONFIG_DIR}"
41 url: "git@gitlab.com:git-cola/git-cola.git"
42 commands:
43 develop: ${PIP} install --editable .
44 doc: garden -vv cmd docs html man
45 check: |
46 garden -vv test
47 garden -vv doc
48 garden -vv pylint
49 fmt: |
50 ${CERCIS} --version
51 ${GIT} ls-files -- '*.py' |
52 ${GREP} -v ^qtpy |
53 ${XARGS} ${CERCIS} "$@"
54 html: garden -vv html docs
55 install: |
56 if test -n "${DESTDIR}"
57 then
58 pip_root="--root=${DESTDIR}"
59 export DESTDIR="${DESTDIR}"
60 fi
61 ${PIP} install --disable-pip-version-check $pip_root --prefix=${prefix} "$@" .
62 i18n: |
63 garden -vv pot
64 garden -vv po
65 macos/app: |
66 ${MKDIR_P} ${cola_app}/Contents/MacOS
67 ${MKDIR_P} ${cola_app_resources}
68 ${PYTHON} -m venv ${cola_app_resources}
69 ${cola_app_resources}/bin/pip install --requirement requirements/requirements.txt
70 ${cola_app_resources}/bin/pip install --requirement requirements/requirements-optional.txt
71 ${cola_app_resources}/bin/pip install --requirement requirements/requirements-dev.txt
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 -D PIP=${cola_app_resources}/bin/pip -D prefix=${cola_app_resources} install
81 garden -D SPHINXBUILD=${cola_app_resources}/bin/sphinx-build doc
82 garden -D SPHINXBUILD=${cola_app_resources}/bin/sphinx-build -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: garden -vv -D prefix=${TREE_PATH}/pages install docs
108 pylint: |
109 ${PYLINT} --version
110 ${PYLINT} --rcfile=.pylintrc ${PYLINT_OPTIONS} "$@" cola test
111 requirements: ${PIP} install --requirement requirements/requirements.txt
112 requirements/maint: ${PIP} install --requirement requirements/requirements-maint.txt
113 requirements/opt: ${PIP} install --requirement requirements/requirements-optional.txt
114 requirements/dev: ${PIP} install --requirement requirements/requirements-dev.txt
115 test: ${PYTEST} ${PYTEST_OPTIONS} "$@" cola test
116 tox: ${TOX} ${TOX_OPTIONS} --parallel auto -e "${TOX_ENVS}" "$@"
117 tox/check: ${TOX} ${TOX_OPTIONS} --parallel auto -e check "$@"
118 remotes:
119 BaumiCoder: "https://github.com/BaumiCoder/git-cola.git"
120 DasaniT: "https://github.com/DasaniT/git-cola.git"
121 Mailaender: "https://github.com/Mailaender/git-cola.git"
122 Mithil467: "https://github.com/Mithil467/git-cola.git"
123 NielBuys: "https://github.com/NielBuys/git-cola.git"
124 WNguyen14: "https://github.com/WNguyen14/git-cola.git"
125 abid1998: "https://github.com/abid1998/git-cola.git"
126 achernet: "https://github.com/achernet/git-cola.git"
127 axel-h: "https://github.com/axel-h/git-cola.git"
128 bearsh: "https://github.com/bearsh/git-cola.git"
129 bensmrs: "https://github.com/bensmrs/git-cola.git"
130 bobvanderlinden: "https://github.com/bobvanderlinden/git-cola.git"
131 brccabral: "https://github.com/brccabral/git-cola.git"
132 davvid: "git@github.com:davvid/git-cola.git"
133 dschwoerer: "https://github.com/dschwoerer/git-cola.git"
134 florisla: "https://github.com/florisla/git-cola.git"
135 fu7mu4: "https://github.com/fu7mu4/git-cola.git"
136 gdebure: "https://github.com/gdebure/git-cola.git"
137 github: "git@github.com:git-cola/git-cola.git"
138 guoyunhe: "https://github.com/guoyunhe/git-cola.git"
139 gyuris: "https://github.com/gyuris/git-cola.git"
140 haffmans: "https://github.com/haffmans/git-cola.git"
141 harmathy: "https://github.com/harmathy/git-cola.git"
142 hsoft: "https://github.com/hsoft/git-cola.git"
143 jamie-pate: "https://github.com/jamie-pate/git-cola.git"
144 kenyuy: "https://github.com/kenyuy/git-cola.git"
145 kisaragi-hiu: "https://github.com/kisaragi-hiu/git-cola.git"
146 kneirinck: "https://github.com/kneirinck/git-cola.git"
147 kurtmckee: "https://github.com/kurtmckee/git-cola.git"
148 laerreal: "https://github.com/laerreal/git-cola.git"
149 lah7: "https://github.com/lah7/git-cola.git"
150 living180: "https://github.com/living180/git-cola.git"
151 ljhcage: "https://github.com/ljhcage/git-cola.git"
152 malpas: "https://github.com/malpas/git-cola.git"
153 melkecelioglu: "https://github.com/melkecelioglu/git-cola.git"
154 milestone12: "https://github.com/milestone12/git-cola.git"
155 mmargoliono: "https://github.com/mmargoliono/git-cola"
156 mp-chet: "https://github.com/mp-chet/git-cola.git"
157 nakanoi: "https://github.com/nakanoi/git-cola.git"
158 nandalopes: "https://github.com/nandalopes/git-cola.git"
159 OriShalhon: "https://github.com/OriShalhon/git-cola.git"
160 pilarmolinalopez: "https://github.com/pilarmolinalopez/git-cola.git"
161 quintusfelix: "https://github.com/quintusfelix/git-cola.git"
162 rafaelreuber: "https://github.com/rafaelreuber/git-cola.git"
163 scop: "https://github.com/scop/git-cola.git"
164 sergei-dyshel: "https://github.com/sergei-dyshel/git-cola.git"
165 sthalik: "https://github.com/sthalik/git-cola.git"
166 skunkwerks: "https://github.com/skunkwerks/git-cola.git"
167 takluyver: "https://github.com/takluyver/git-cola.git"
168 thk123: "https://github.com/thk123/git-cola.git"
169 timgates42: "https://github.com/timgates42/git-cola.git"
170 vdragon: "https://github.com/Vdragon/git-cola.git"
171 victorhck: "https://github.com/victorhck/git-cola.git"
172 virtualstaticvoid: "https://github.com/virtualstaticvoid/git-cola.git"
173 wm4: "https://github.com/wm4/git-cola.git"
174 wojnilowicz: "https://github.com/wojnilowicz/git-cola.git"
175 yaellevy: "https://github.com/yaellevy/git-cola.git"
176 deb:
177 description: Debian packaging for Git Cola
178 url: "git@gitlab.com:git-cola/git-cola-debian.git"
179 remotes:
180 davvid: "git@github.com:davvid/git-cola-debian.git"
181 docs:
182 commands:
183 clean: rm -fr _build
184 doctest: ${SPHINXBUILD} -b doctest ${SPHINX_OPTIONS} _build/doctest
185 html: ${SPHINXBUILD} -b html ${SPHINX_OPTIONS} _build/html
186 man: ${SPHINXBUILD} -b man ${SPHINX_OPTIONS} _build/man
187 linkcheck: ${SPHINXBUILD} -b linkcheck ${SPHINX_OPTIONS} _build/linkcheck
188 install: |
189 ${MKDIR_P} ${DESTDIR}${docdir}
190 ${INSTALL} -m 644 *.html ${DESTDIR}${docdir}
191 ${INSTALL} -m 644 *.rst ${DESTDIR}${docdir}
192 # HTML documentation
193 ${MKDIR_P} ${DESTDIR}${htmldir}
194 ${RSYNC} ${RSYNC_OPTIONS} _build/html/ ${DESTDIR}${htmldir}/
195 # Manual pages
196 ${MKDIR_P} ${DESTDIR}${mandir}
197 ${INSTALL} -m 644 _build/man/git-cola.1 ${DESTDIR}${mandir}
198 ${INSTALL} -m 644 _build/man/git-dag.1 ${DESTDIR}${mandir}
199 fedora:
200 description: Fedora packaging for Git Cola
201 url: "https://src.fedoraproject.org/rpms/git-cola.git"
202 remotes:
203 git-cola: "git@gitlab.com:git-cola/git-cola-fedora.git"
204 davvid: "git@github.com:davvid/git-cola-fedora.git"
205 pages:
206 description: "Git Cola's homepage"
207 url: "git@gitlab.com:git-cola/git-cola.gitlab.io.git"
208 remotes:
209 github: "git@github.com:git-cola/git-cola.github.io.git"
210 ls-jad-elkik: "git://github.com/ls-jad-elkik/git-cola.github.io.git"
211 lz-coder: "https://github.com/lz-coder/git-cola.github.io.git"
212 links:
213 - "https://git-cola.gitlab.io"
214 - "https://git-cola.github.io"
216 # Variables can be overridden externally using "garden -D name=value ...".
217 variables:
218 # Traditional DESTDIR + prefix variables
219 DESTDIR: ""
220 prefix: ${GARDEN_CONFIG_DIR}/dist
221 docdir: ${prefix}/share/doc/git-cola
222 htmldir: ${docdir}/html
223 mandir: ${prefix}/share/man/man1
224 cola_app: ${TREE_PATH}/git-cola.app
225 cola_app_resources: ${cola_app}/Contents/Resources
226 cola_full_version: $ ./bin/git-cola version --brief
227 cola_version: $ sed -e "s/VERSION = '\(.*\)'/\1/" cola/_version.py
228 # External commands and options
229 CERCIS: cercis
230 CP: cp
231 GIT: git
232 GREP: grep
233 INSTALL: install
234 MKDIR_P: mkdir -p
235 MSGMERGE: msgmerge
236 PIP: pip
237 PYLINT: ${PYTHON} -B -m pylint
238 PYLINT_OPTIONS: $ ${PYLINT} --score=no --help >/dev/null 2>&1 && printf '%s' --score=no
239 PYTEST: ${PYTHON} -B -m pytest
240 PYTEST_OPTIONS: $ test "$(uname -s)" != "Linux" && printf '%s' --ignore=cola/inotify.py
241 PYTHON: python3
242 RSYNC: rsync
243 RSYNC_OPTIONS: "-r --delete --exclude=.buildinfo"
244 SED: sed
245 SPHINXBUILD: sphinx-build
246 SPHINX_OPTIONS: "-d _build/doctrees -a ."
247 TOX: tox
248 TOX_OPTIONS: "--develop --skip-missing-interpreters"
249 TOX_ENVS: "py36,py37,py38,py39,py310,py311"
250 XARGS: xargs
251 XGETTEXT: xgettext
253 ...