README.md

   1 Armband Fuel@OPNFV
   2 ==================
   3
   4 This repository holds build scripts for Fuel 10.0 OPNFV installer
   5 for AArch64 machines.
   6
   7 Workflow
   8 --------
   9 The standard workflow should look as follows:
  10
  11 1. Clone the repository.
  12
  13 2. All the sub-projects are registered as submodules. To initialize them, call:
  14    $ make submodules-init
  15
  16 3. Apply patches from `patches/<sub-project>/*` to respective submodules via:
  17    $ make patches-import
  18
  19    This will result in creation of:
  20    - a tag called `${A_OPNFV_TAG}-root` at submodule remote branch HEAD;
  21    - a new branch `opnfv-armband` which will hold all the armband work.
  22    Then each patch is applied on this new branch with `git-am`.
  23    The new HEAD is tagged with `${A_OPNFV_TAG}`.
  24
  25 4. Modify sub-projects for whatever you need.
  26    Commit your changes when you want them taken into account in the build.
  27
  28    NOTE: If you want to re-export patches, make sure to move the tag
  29    `${A_OPNFV_TAG}` to the latest commit that should be included.
  30
  31 5. Build with:
  32    $ make build
  33
  34 6. Re-create patches via:
  35    $ make patches-export
  36
  37    Each commit on `opnfv-armband` branch of each subproject will be
  38    exported to `patches/subproject/` via `git format-patch`.
  39
  40 7. Clean workbench branches and tags with:
  41    $ make submodules-clean
  42
  43 Sub-projects
  44 ------------
  45 If you need to add another subproject, you can do it with `git submodule`.
  46 Make sure that you specify branch (with `-b`), short name (with `--name`)
  47 and point it to `upstream/*` directory, i.e.:
  48
  49    $ git submodule -b stable/mitaka add --name fuel-web \
  50      https://github.com/openstack/fuel-web.git upstream/fuel-web
  51
  52 Fuel@OPNFV submodule patch development
  53 --------------------------------------
  54 Fuel-submodules (fuel-astute, ... , fuel-ui) patches also reside in Armband,
  55 like previously described patches that are applied to Armband submodules,
  56 but they are not directly applied to any submodule in Armband.
  57 Instead, they are copied (staged) to Fuel@OPNFV submodule, which will
  58 automatically pick them up and apply them to its own submodules
  59 (fuel-astute, ... , fuel-ui) during ISO build.
  60
  61 The following helpers are available for working with patches for
  62 Fuel-submodules (fuel-astute, ... , fuel-ui):
  63
  64 1. Clean Fuel-submodules (fuel-astute, ... , fuel-ui) patches
  65    $ make fuel-patches-clean
  66
  67 2. Import Fuel-submodules staged patches
  68    $ make fuel-patches-import
  69
  70 3. Export Fuel-submodules patches
  71    $ make fuel-patches-export