admin/notes/hydra

   1 -*- mode: outline; coding: utf-8 -*-
   2
   3 Copyright (C) 2013-2024 Free Software Foundation, Inc.
   4 See the end of the file for license conditions.
   5
   6 NOTES FOR EMACS CONTINUOUS BUILD ON HYDRA
   7
   8 A continuous build for Emacs can be found at
   9 https://hydra.nixos.org/jobset/gnu/emacs-trunk
  10
  11 * It builds Emacs on various platforms.
  12 Sometimes jobs fail due to hydra problems rather than Emacs problems.
  13
  14 * Mail notifications
  15 In addition to the web interface, Hydra can send notifications by
  16 email when the build status of a project changes, e.g., from
  17 SUCCEEDED to FAILED.  It sends notifications about build status in
  18 Emacs trunk to emacs-buildstatus@gnu.org.
  19
  20 If you want to receive these notifications, please subscribe at
  21 https://lists.gnu.org/mailman/listinfo/emacs-buildstatus
  22
  23 (This feature seems to have been broken for ages.)
  24
  25 * The Emacs jobset consists of the following jobs:
  26
  27 ** The 'tarball' job
  28 which gets a checkout from the repository, and does a bootstrap followed
  29 by running make-dist to create a tarball.  If this job fails, all the
  30 others will too (because they use the tarball as input).
  31
  32 ** The 'build' job
  33 which starts from the tarball and does a normal build.
  34
  35 ** The 'coverage' job
  36 does a gcov build and then runs 'make check-expensive'.  Fails if any
  37 test fails.
  38
  39 * Nix expressions
  40 The recipe for GNU Emacs are available via Git:
  41 https://git.savannah.gnu.org/cgit/hydra-recipes.git/tree/emacs
  42
  43 To modify the build job, email the patch to hydra-users@gnu.org.  The
  44 build recipes are written in the Nix language.
  45
  46 * Identifying hydra
  47 Lisp packages, Makefiles, scripts, and other software could determine
  48 whether they run on hydra by checking for the environment variable
  49 EMACS_HYDRA_CI.
  50
  51 * Other Information
  52 For a list of other GNU packages that have a continuous build on
  53 Hydra, see https://hydra.nixos.org/project/gnu
  54
  55 See https://www.gnu.org/software/devel.html#Hydra for more information.
  56
  57 \f
  58 This file is part of GNU Emacs.
  59
  60 GNU Emacs is free software: you can redistribute it and/or modify
  61 it under the terms of the GNU General Public License as published by
  62 the Free Software Foundation, either version 3 of the License, or
  63 (at your option) any later version.
  64
  65 GNU Emacs is distributed in the hope that it will be useful,
  66 but WITHOUT ANY WARRANTY; without even the implied warranty of
  67 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  68 GNU General Public License for more details.
  69
  70 You should have received a copy of the GNU General Public License
  71 along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.