README.md

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) 2017 Enea AB and others
   4
   5 Armband Fuel@OPNFV
   6 ==================
   7
   8 This repository holds build scripts for MCP Fuel OPNFV installer
   9 for AArch64 machines.
  10
  11 Workflow
  12 --------
  13 The standard workflow should look as follows:
  14
  15 1. Clone the repository.
  16
  17 2. All the sub-projects are registered as submodules. To initialize them, call:
  18    $ make submodules-init
  19
  20 3. Apply patches from `patches/<sub-project>/*` to respective submodules via:
  21    $ make patches-import
  22
  23    This will result in creation of:
  24    - a tag called `${A_OPNFV_TAG}-root` at submodule remote branch HEAD;
  25    - a new branch `opnfv-armband` which will hold all the armband work.
  26    Then each patch is applied on this new branch with `git-am`.
  27    The new HEAD is tagged with `${A_OPNFV_TAG}`.
  28
  29 4. Modify sub-projects for whatever you need.
  30    Commit your changes when you want them taken into account in the build.
  31
  32    NOTE: If you want to re-export patches, make sure to move the tag
  33    `${A_OPNFV_TAG}` to the latest commit that should be included.
  34
  35 5. (not implemented yet for MCP) Build with:
  36    $ make build
  37
  38 6. Re-create patches via:
  39    $ make patches-export
  40
  41    Each commit on `opnfv-armband` branch of each subproject will be
  42    exported to `patches/subproject/` via `git format-patch`.
  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