Giter Club home page Giter Club logo

bumpy's Introduction

Version Bump and Publish Script

This script is an assistant tool for maintaining JavaScript and TypeScript packages (not services), specifically those managed with NPM and Git. It provides automated assistance with versioning and preparing the project for publication.

Usage

To use this script, you should copy it to your project's root directory. Then, you can run it directly from your terminal with the command ./publish-client.sh. The script will guide you through its process via a series of prompts and messages.

Important: The script does not execute any command. It just generates commands you can run if you want to publish your script.

Features

  • Automated Version Bumping: The script facilitates version incrementation according to semantic versioning. It provides two ways to bump the version:

    • By using the npm version command. You can choose to increment the major, minor, or patch version.
    • Manually, by allowing you to edit the package.json file yourself.
  • Git Commands Generation: The script generates a list of git commands for you to run in order to tag the new version and push your changes to the repository. It doesn't execute these commands, giving you full control and allowing for manual review.

  • Uncommitted Changes Check: It checks if there are uncommitted changes in your current branch. If it finds any, it informs you and halts its process until these changes are committed. This way, it helps maintain a clean state in your version control system.

  • Automated Switch to Main Branch: The script automatically switches to the main branch and pulls the latest changes before proceeding with its operations. This ensures you're always working with the latest codebase.

  • Project Directory Check: The script verifies it's being run within the correct project directory. It looks for the presence of a package.json file and a specific directory name (client) before proceeding.

bumpy's People

Contributors

janosvajda avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.