Skip to content

Repository files navigation

Git-Client

This repository validates the Git command line client as a software lifecycle tool. The validation is automated by amber, documented with autodoc, built with docbld, and exercised against the QuickSort product repository.

Each ~/soup folder is treated as a complete product checkout. git-client uses the local ~/soup/quicksort repository to prepare a temporary bare Git remote under remote/quicksort.git inside the current git-client checkout; Amber then validates Git CLI behavior by cloning, branching, committing, pushing, merging, reverting, and tagging against that local remote.

Supported Systems

git-client targets Linux-like shells with Ruby, Git, Amber, Autodoc, docbld, and tlc-article available.

Prerequisites

Applications

  1. git client
  2. Ruby
  3. Rake
  4. Bundler

Clone Repositories

  1. amber
  2. autodoc
  3. docbld
  4. tlc-article
  5. QuickSort

Validating Git Command Line Client

  1. Meet all prerequisites.
  2. Ensure AMBERPATH, AUTODOCPATH, and DOCBLDPATH are defined.
  3. Ensure ~/soup/quicksort is present.
  4. Move to ~/soup/git-client.
  5. Run the validation task.
cd ~/soup/git-client
rake validate:git

The validation task fails if required environment variables are missing, if the local QuickSort product checkout is unavailable, if Amber returns a non-zero status, or if docbld cannot build and deploy the report.

Review the git-client.pdf

Report moved to _build/git-client.pdf

About

Example tool validation report assembled using amber, autodoc, tlc-article, and docbld.

Resources

Code of conduct

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages