Skip to content

Repository files navigation

setup-git-flow

GitHub Release CI License Node.js

Automated setup wizard for Git Flow with semantic versioning, conventional commits, and automated releases.

Features

  • Interactive CLI setup wizard
  • Automatic dependency configuration
  • Commitlint validation for conventional commits
  • Semantic Release integration for automated versioning
  • GitHub Actions workflow for automated releases
  • Husky hooks for pre-commit validation

Requirements

  • Node.js 22+
  • Git repository
  • GitHub repository (for automated releases)

Installation

npx github:OGR-67/setup-git-flow

Or clone the repository and run:

git clone https://github.com/OGR-67/setup-git-flow.git
cd setup-git-flow
node index.js

Usage

Run the setup wizard and answer the prompts:

node index.js

The wizard will:

  1. Ask for your project name, description, and GitHub organization
  2. Create or update package.json with required dependencies
  3. Configure commitlint, semantic-release, and GitHub Actions
  4. Install dependencies and setup Husky hooks

Configuration Files

  • .releaserc.json — Semantic Release configuration
  • commitlint.config.js — Commit message validation rules
  • .github/workflows/release.yml — Automated release workflow

License

MIT

About

Helps to setup everithing you need to have a perfect git flow

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages