build/rails-package-scripts/README.md

   1 [//]: # Copyright (C) The Arvados Authors. All rights reserved.
   2 [//]: #
   3 [//]: # SPDX-License-Identifier: AGPL-3.0
   4
   5 When run-build-packages.sh builds a Rails package, it generates the package's pre/post-inst/rm scripts by concatenating:
   6
   7 1. package_name.sh, which defines variables about where package files live and some human-readable names about them.
   8 2. step2.sh, which uses those to define some utility variables and set defaults for things that aren't set.
   9 3. stepname.sh, like postinst.sh, prerm.sh, etc., which uses all this information to do the actual work.
  10
  11 Since our build process is a tower of shell scripts, concatenating files seemed like the least worst option to share code between these files and packages.  More advanced code generation would've been too much trouble to integrate into our build process at this time.  Trying to inject portions of files into other files seemed error-prone and likely to introduce bugs to the end result.
  12
  13 postinst.sh lets the early parts define a few hooks to control behavior:
  14
  15 * After it installs the core configuration files (database.yml, application.yml, and production.rb) to /etc/arvados/server, it calls setup_extra_conffiles.  By default this is a noop function (in step2.sh).  API server defines this to set up the old omniauth.rb conffile.
  16 * Before it restarts nginx, it calls setup_before_nginx_restart.  By default this is a noop function (in step2.sh).  API server defines this to set up the internal git repository, if necessary.
  17 * $RAILSPKG_DATABASE_LOAD_TASK defines the Rake task to load the database.  API server uses db:structure:load.  SSO server uses db:schema:load.  Workbench doesn't set this, which causes the postinst to skip all database work.
  18 * If $RAILSPKG_SUPPORTS_CONFIG_CHECK != 1, it won't run the config:check rake task.  SSO clears this flag (it doesn't have that task code).