fatback

Requirements

• node/npm

How To Notes

Git Configuration

1. git config --global diff.submodule log (so you get clearer container diffs when referenced submodule commits changed)
2. git config --global fetch.recurseSubmodules on-demand (so you are confident new referenced commits for known submodules get fetched with container updates)
3. git config --global status.submoduleSummary true (so git status gets useful again when a referenced submodule commit changed)

Install

1. install node/npm
2. clone fatback
3. cd fatback
4. npm run init-comp (WARNING: this will delete any uncommitted changes)
5. npm install
6. npm run setup-comp
7. npm run build-comp NOTE: AS OF v0.15.0 THIS IS CURRENTLY NOT SUPPORTED
8. cd path/to/submodule
9. execute any custom configurations/build steps for each submodule

Switching/pulling fatback branch updates /

1. git pull / checkout
2. start Install#3 above for fresh build

Adding a submodule

1. git submodule add [repo url]
2. add submodule configuration to fatback/package.json#dependencies

for example "@brightsign/<package_name>": "file:./<package_name>",

for a package named ‘ba-notification-ui’, the entry would be “@brightsign/ba-notification-ui”: “file:./ba-notification-ui”,

note, the assumed order of fatback/package.json#dependencies is such that submodules are specified before the submodules they depend on. For example, "@brightsign/bacon": "file:./bacon" is specified before all other submodules as bacon depends on all other submodules (directly or indirectly) but has no submodules which depend on it

3. add package.json#dependencies configuration for all other submodules that require the newly added submodule

for example "@brightsign/<package_name>": "",

for a package named ba-notificiation-ui, the entry might be “@brightsign/ba-notification-ui”: “0.0.2”, or, for a package not published yet, it might have the form “@brightsign/ba-notification-ui”: “git+ssh://[email protected]:ba-notification-ui#41a1b60605ead9794ec8fdb931f3833d5”

for more information regarding npm dependency definition formats, see https://docs.npmjs.com/files/package.json#dependencies

4. start Install#3 above for fresh build

Permanently removing a submodule

1. git submodule deinit path/to/submodule
2. git rm path/to/submodule
3. git commit -am “Removed submodule X”
4. start Install#3 above for fresh build

Grabbing updates/change branch from a submodule

1. cd path/to/submodule
2. git fetch
3. git checkout [commit-sha1 | branch]
4. cd -
5. git commit -am “Updated submodule X to: blah blah”
6. git push
7. start Install#6 above for fresh build

Pushing updates to a submodule

1. git submodule update --remote --rebase -- path/to/module
2. cd path/to/submodule
3. local work, testing, eventually staging
4. git commit -am “Update to central submodule: blah blah”. WARNING: if committing to local head, checking out remote branch after this step will wipe locally committed (unpushed) changes. It is recommended that you instead work from a local branch when making changes to submodules
5. git push
6. cd -
7. git commit -am “Updated submodule X to: blah blah”
8. git push