README.md

   1 Armband Fuel@OPNFV
   2 ==================
   3
   4 This repository holds build scripts for Fuel 9.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 `armband-workbench-root` at the same commit as Fuel@OPNFV
  21    hard sets in `build/config.mk` (inside fuel submodule);
  22    - a new branch `armband-workbench` which will hold all the armband work.
  23    Then each patch is applied on this new branch with `git-am`.
  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 5. Build with:
  29    $ make build
  30
  31 6. Re-create patches via:
  32    $ make patches-export
  33
  34    Each commit on `armband-workbench` branch of each subproject will be
  35    exported to `patches/subproject/` via `git format-patch`.
  36
  37    NOTE: DO NOT commit changed submodules. Remember to commit only patches!
  38
  39    Commiting changed submodules (`git diff` will list something like:
  40    `Subproject commit: {hash}`) will break the repo, as the new commit hash
  41    is non-existant in the upstream repo, hence anybody cloning the repository
  42    later will fail on `make submodules-init`.
  43
  44 7. Clean workbench branches and tags with:
  45    $ make submodules-clean
  46
  47 Sub-projects
  48 ------------
  49 If you need to add another subproject, you can do it with `git submodule`.
  50 Make sure that you specify branch (with `-b`), short name (with `--name`)
  51 and point it to `upstream/*` directory, i.e.:
  52
  53    $ git submodule -b stable/mitaka add --name fuel-web \
  54      https://github.com/openstack/fuel-web.git upstream/fuel-web