docit

• 

  Just a sketch

Inspiration

The loop over issue tickets, code changes, tests, test results normally is in sync. The end user documentation often is not in sync with this loop. There should be methods and tools to change that.

What it does

The current code just sketches one approach for one part of the problem.

• it focusses just on the .feature files of bdd tests and isn't flexible/configurable.
• the output is not really nice
• the workflow is hacky

But the person in charge of keeping the end user documentation in sync gets a report about

• new .features files -> probably a new feature to include in the documentation
• deletetd .features files -> probably a feature to remove from the documentation
• changed .features files -> most likely a feature that has to be changed in the documentation

One shortcoming is, that remote files currently ars shown as tmp files. That can be fixed with more work. Unchanged features are not reported as that would be a waste of time. If wanted taht can be changed with more work.

The idea used is to (mis)use git difftool -y --extcmd /path/to/customDiffToolThatCreatesTheReport not for diffing but for reporting.

How I built it

Shell, Python, git.

Challenges I ran into

Find out about that a external difftool can be used and what parameter values the external difftool gets.

Accomplishments that I'm proud of

I'm glad that id some research and found some interesting information.

What I learned

Learning more about git and difftool.

What's next for docit

Think about a usable workflow and start to implement that from scratch.

Built With

• git
• python