gitworkflows - Linux

Overview

gitworkflows is a command-line tool for defining and managing custom Git workflows. It allows users to streamline common Git operations, reduce manual work, and enforce best practices.

Syntax

gitworkflows [command] [options] [arguments]

Options/Flags

  • -h, –help: Display help and usage information.
  • -v, –version: Print the version number.
  • -c, –config-file : Specify the path to the configuration file. (Default: ~/.gitworkflows.yaml)
  • -p, –profile : Select a workflow profile to use.
  • -l, –list: List available workflow profiles.

Examples

Create a custom workflow profile:

gitworkflows create <profile-name>

Apply a workflow profile to a Git repository:

gitworkflows apply <profile-name>

Execute a workflow step:

gitworkflows execute <step-name>

List available workflow steps in a profile:

gitworkflows steps <profile-name>

Common Issues

  • Error: Configuration file not found: Ensure the configuration file is present at the default location or the specified --config-file path.
  • Error: Workflow profile not found: Create the profile using gitworkflows create before applying it.
  • Error: Step not found: Verify that the step exists in the workflow profile’s configuration.

Integration

With Git:

git add && gitworkflows execute commit

With Docker:

gitworkflows execute build && docker build -t my-image .

Related Commands

  • git: The underlying version control system.
  • make: A general-purpose build tool.
  • gh: A command-line tool for interacting with GitHub.