User scenarios .phlow

[lakruzz]

Here's how I would like to see the desired behaviour of our .phlow files

• must be a valid git config file

Currently we're using underscores in some of our key names - that is not compliant

• all properties that can be set from the .phlow file must have program defined defaults

• all program defaults should work against GitHub and GitHub issues

• all defaults must be configurable on machine level (system) user level (global) and repository level (.phlow in repo root)

Currently we're not git config file compliant

• All phlow settings shall be part of the git config query system

Eample

git config --get phlow.remote

Currently the .phlow file in the repo is queried directly by git-phlow program.

The .phlow should be renamed to .gitconfig in order to adapt to conventions - and can be included in the standard git query by the following command (assuming it's made compliant prior to this step):

git config --local include.path ../.gitconfig

This is results in the following include clause in the repos /.git/config file:

[include]
	path = ../.gitconfig

• the phlow shall be able to run (using program defaults) even if none of the three configuration levels are defined

Example: only if the git config... query in the example above returns a non-zero error coder shall program defaults be used.

Currently .phlow is required in the repo

• the local .phlow file shall not be created automatically.

Currently it's created if it doesn't exist

[lakruzz]

Solution

It appears that including the local (repo) level is what seems to be causing the challenge here.

But there seem to exist a viable and generally accepted solution.

In the following examples it's assumed that the content of .phlow is made compliant so the current settings :

[default]
  remote                 = origin
  service                = github
  integration_branch     = master
  issue_url              = https://api.github.com
  delivery_branch_prefix = ready

are changed to

[phlow]
  remote                 = origin
  service                = github
  integration-branch     = master
  issue-url              = https://api.github.com
  delivery-branch-prefix = ready

1. The section default is changed to `phlow``
2. All underscores _ are changed to dashes `-``

Actually since these are all default values they could all be removed.

Example - Changing a setting on a global scope

This can be done using git config:

The first query fails - but after it's set - it's valid. The information is persisted in the ~/.gitconfig which now contains

[phlow]
	...
        ...
	service = bitbucket

Example - Changing a setting on a local scope

The local scope is read from the individual repo's config file: .git/configbut this file is purely local - it's not involved in clone/push/pull operations. so it will have to be persisted somewhere else.

Ideally in a .gitconfig file that resides in the root of the repo:

The following command

git config --file .gitconfig --replace-all phlow.integration-branch gh-pages

will result in the following configuration being written to a .gitconfig file

[phlow]
	integration-branch = gh-pages

it then can be included in the local git configuration like this:

 git config --local --add include.path ../.gitconfig

We still have one slight inconvenience to overcome using this approach; the local config file .git/config is created when we clone it's never cloned. so Either:

1. Users must be instructed to run git config --local --add include.path ../.gitconfig
2. We should include the operation automatically:

[ -e .gitconfig ] && git config --local --replace-all include.path ../.gitconfig

[lakruzz]

Note on writing to the local .gitconfigfile

To ensure that this is stored in a .gitconfig file in the root of the repo we must either

1. Change directory to the repo root before execution
2. include the repo root to the path

cd `git rev-parse --show-toplevel`
git config --file .gitconfig --add phlow.integration-branch gh-pages

or

git config --file `git rev-parse --show-toplevel`.gitconfig --add phlow.integration-branch gh-pages

[groenborg]

@lakruzz Do we want a config command with git phlow that can bootstrap a new configuration file if the user wants, and a command that enables the user to see a configuration without having to look through .gitconfig files?

e.g.

Bootstrap

git phlow config bootstrap

creates a new .gitconfig with a default configuration for the user to change

Show config

git phlow config show jira

prints the Jira configuration to the terminal

[lakruzz]

@groenborg

Don't we just want to implement the (missing) git config switch?

git config --repo ...