garden.yaml

   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 "black"
  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 #
  18 #   # Installation
  19 #   garden install              # Install git-cola to the installation ${prefix}
  20 #   garden install docs         # Install documentation
  21 #
  22 #   # Variables can be overridden using "-D name=value", eg:
  23 #   garden -D DESTDIR=/tmp/stage -D prefix=/usr/local install
  24 #   garden -D prefix=$PWD/dist install docs
  25 #
  26 #   # Related Projects
  27 #   garden grow pages           # Clone the Git Cola homepage
  28 #   garden grow fedora          # Clone the Fedora packaging
  29 #   garden grow deb             # Clone the Debian packaging
  30 ---
  31 garden:
  32   root: "${GARDEN_CONFIG_DIR}"
  33
  34 trees:
  35   git-cola:
  36     path: "${GARDEN_CONFIG_DIR}"
  37     url: "git@gitlab.com:git-cola/git-cola.git"
  38     commands:
  39       develop: ${PIP} install --editable .
  40       doc: garden -vv cmd docs html man
  41       check: |
  42         garden -vv test
  43         garden -vv doc
  44         garden -vv pylint
  45       fmt: |
  46         ${GIT} ls-files -- '*.py' |
  47         ${GREP} -v ^qtpy |
  48         ${XARGS} ${BLACK} --skip-string-normalization
  49       html: garden -vv html docs
  50       install: |
  51         if test -n "${DESTDIR}"
  52         then
  53             pip_root="--root=${DESTDIR}"
  54             export DESTDIR="${DESTDIR}"
  55         fi
  56         ${PIP} install --disable-pip-version-check $pip_root --prefix=${prefix} "$@" .
  57       po: |
  58         for po in cola/i18n/*.po
  59         do
  60             ${MSGMERGE} \
  61                 --no-wrap \
  62                 --no-fuzzy-matching \
  63                 --sort-output \
  64                 --output-file $$po.new \
  65                 $$po \
  66                 cola/i18n/git-cola.pot
  67             mv $$po.new $$po
  68         done
  69       pot: |
  70         ${XGETTEXT} \
  71             --language=Python \
  72             --keyword=N_ \
  73             --no-wrap \
  74             --omit-header \
  75             --sort-output \
  76             --output-dir cola/i18n \
  77             --output git-cola.pot \
  78             cola/*.py \
  79             cola/*/*.py
  80       man: garden -vv man docs
  81       pylint: |
  82         ${PYLINT} --version
  83         ${PYLINT} --rcfile=.pylintrc ${PYLINT_OPTIONS} "$@" cola test
  84       requirements: ${PIP} install --requirement requirements/requirements.txt
  85       requirements/opt: ${PIP} install --requirement requirements/requirements-optional.txt
  86       requirements/dev: ${PIP} install --requirement requirements/requirements-dev.txt
  87       test: ${PYTEST} ${PYTEST_OPTIONS} "$@" cola test
  88     remotes:
  89       DasaniT: "https://github.com/DasaniT/git-cola.git"
  90       Mailaender: "https://github.com/Mailaender/git-cola.git"
  91       Mithil467: "https://github.com/Mithil467/git-cola.git"
  92       NielBuys: "https://github.com/NielBuys/git-cola.git"
  93       WNguyen14: "https://github.com/WNguyen14/git-cola.git"
  94       abid1998: "https://github.com/abid1998/git-cola.git"
  95       achernet: "https://github.com/achernet/git-cola.git"
  96       axel-h: "https://github.com/axel-h/git-cola.git"
  97       bearsh: "https://github.com/bearsh/git-cola.git"
  98       bensmrs: "https://github.com/bensmrs/git-cola.git"
  99       bobvanderlinden: "https://github.com/bobvanderlinden/git-cola.git"
 100       brccabral: "https://github.com/brccabral/git-cola.git"
 101       davvid: "git@github.com:davvid/git-cola.git"
 102       dschwoerer: "https://github.com/dschwoerer/git-cola.git"
 103       florisla: "https://github.com/florisla/git-cola.git"
 104       fu7mu4: "https://github.com/fu7mu4/git-cola.git"
 105       gdebure: "https://github.com/gdebure/git-cola.git"
 106       github: "git@github.com:git-cola/git-cola.git"
 107       guoyunhe: "https://github.com/guoyunhe/git-cola.git"
 108       gyuris: "https://github.com/gyuris/git-cola.git"
 109       haffmans: "https://github.com/haffmans/git-cola.git"
 110       harmathy: "https://github.com/harmathy/git-cola.git"
 111       hsoft: "https://github.com/hsoft/git-cola.git"
 112       jamie-pate: "https://github.com/jamie-pate/git-cola.git"
 113       kenyuy: "https://github.com/kenyuy/git-cola.git"
 114       kisaragi-hiu: "https://github.com/kisaragi-hiu/git-cola.git"
 115       kneirinck: "https://github.com/kneirinck/git-cola.git"
 116       kurtmckee: "https://github.com/kurtmckee/git-cola.git"
 117       laerreal: "https://github.com/laerreal/git-cola.git"
 118       lah7: "https://github.com/lah7/git-cola.git"
 119       living180: "https://github.com/living180/git-cola.git"
 120       ljhcage: "https://github.com/ljhcage/git-cola.git"
 121       malpas: "https://github.com/malpas/git-cola.git"
 122       melkecelioglu: "https://github.com/melkecelioglu/git-cola.git"
 123       milestone12: "https://github.com/milestone12/git-cola.git"
 124       mmargoliono: "https://github.com/mmargoliono/git-cola"
 125       mp-chet: "https://github.com/mp-chet/git-cola.git"
 126       nakanoi: "https://github.com/nakanoi/git-cola.git"
 127       nandalopes: "https://github.com/nandalopes/git-cola.git"
 128       pilarmolinalopez: "https://github.com/pilarmolinalopez/git-cola.git"
 129       quintusfelix: "https://github.com/quintusfelix/git-cola.git"
 130       rafaelreuber: "https://github.com/rafaelreuber/git-cola.git"
 131       scop: "https://github.com/scop/git-cola.git"
 132       sergei-dyshel: "https://github.com/sergei-dyshel/git-cola.git"
 133       skunkwerks: "https://github.com/skunkwerks/git-cola.git"
 134       takluyver: "https://github.com/takluyver/git-cola.git"
 135       thk123: "https://github.com/thk123/git-cola.git"
 136       timgates42: "https://github.com/timgates42/git-cola.git"
 137       vdragon: "https://github.com/Vdragon/git-cola.git"
 138       victorhck: "https://github.com/victorhck/git-cola.git"
 139       virtualstaticvoid: "https://github.com/virtualstaticvoid/git-cola.git"
 140       wm4: "https://github.com/wm4/git-cola.git"
 141       wojnilowicz: "https://github.com/wojnilowicz/git-cola.git"
 142   deb:
 143     description: Debian packaging for Git Cola
 144     url: "git@gitlab.com:git-cola/git-cola-debian.git"
 145     remotes:
 146       davvid: "git@github.com:davvid/git-cola-debian.git"
 147   docs:
 148     commands:
 149       clean: rm -fr _build
 150       doctest: ${SPHINXBUILD} -b doctest ${SPHINX_OPTIONS_ALL} _build/doctest
 151       html: ${SPHINXBUILD} -b html ${SPHINX_OPTIONS_ALL} _build/html
 152       man: ${SPHINXBUILD} -b man ${SPHINX_OPTIONS_ALL} _build/man
 153       linkcheck: ${SPHINXBUILD} -b linkcheck ${SPHINX_OPTIONS_ALL} _build/linkcheck
 154       install: |
 155         ${MKDIR_P} ${DESTDIR}${docdir}
 156         ${INSTALL} -m 644 *.html ${DESTDIR}${docdir}
 157         ${INSTALL} -m 644 *.rst ${DESTDIR}${docdir}
 158         # HTML documentation
 159         ${MKDIR_P} ${DESTDIR}${htmldir}
 160         ${RSYNC} ${RSYNC_OPTIONS} _build/html/ ${DESTDIR}${htmldir}/
 161         # Manual pages
 162         ${MKDIR_P} ${DESTDIR}${mandir}
 163         ${INSTALL} -m 644 _build/man/git-cola.1 ${DESTDIR}${mandir}
 164         ${INSTALL} -m 644 _build/man/git-dag.1 ${DESTDIR}${mandir}
 165   fedora:
 166     description: Fedora packaging for Git Cola
 167     url: "https://src.fedoraproject.org/rpms/git-cola.git"
 168     remotes:
 169       git-cola: "git@gitlab.com:git-cola/git-cola-fedora.git"
 170       davvid: "git@github.com:davvid/git-cola-fedora.git"
 171   pages:
 172     description: "Git Cola's homepage"
 173     url: "git@gitlab.com:git-cola/git-cola.gitlab.io.git"
 174     remotes:
 175       github: "git@github.com:git-cola/git-cola.github.io.git"
 176       ls-jad-elkik: "git://github.com/ls-jad-elkik/git-cola.github.io.git"
 177       lz-coder: "https://github.com/lz-coder/git-cola.github.io.git"
 178     links:
 179       - "https://git-cola.gitlab.io"
 180       - "https://git-cola.github.io"
 181
 182 # Variables can be overridden externally using "garden -D name=value ...".
 183 variables:
 184   # Traditional DESTDIR + prefix variables
 185   DESTDIR: ""
 186   prefix: ${GARDEN_CONFIG_DIR}/dist
 187   docdir: ${prefix}/share/doc/git-cola
 188   htmldir: ${docdir}/html
 189   mandir: ${prefix}/share/man/man1
 190   # External commands and options
 191   BLACK: black
 192   GIT: git
 193   GREP: grep
 194   INSTALL: install
 195   MKDIR_P: mkdir -p
 196   MSGMERGE: msgmerge
 197   PIP: pip
 198   PYLINT: ${PYTHON} -B -m pylint
 199   PYLINT_OPTIONS: $ ${PYLINT} --score=no --help >/dev/null 2>&1 && printf '%s' --score=no
 200   PYTEST: ${PYTHON3} -B -m pytest
 201   PYTEST_OPTIONS: $ test "$(uname -s)" != "Linux" && printf '%s' --ignore=cola/inotify.py
 202   PYTHON: python3
 203   RSYNC: rsync
 204   RSYNC_OPTIONS: "-r --delete --exclude=.buildinfo"
 205   SPHINXBUILD: sphinx-build
 206   SPHINX_OPTIONS: "-a"
 207   SPHINX_OPTIONS_ALL: "-d _build/doctrees ."
 208   XARGS: xargs
 209   XGETTEXT: xgettext
 210
 211 ...