Giter Club home page Giter Club logo

change's Introduction

Change

Small tool to automate creation of Crystal shards and apps releases.

Change updates CHANGELOG.md and shard.yml, commits it and tags it. It doesn't push it which allows you to give it the final eyeball.

Installation

Change can be installed as a development dependency:

development_dependencies:
  change:
    github: xendk/change

Alternatively you can compile the binary and put it in your path.

Usage

Creating a CHANGELOG.md can be done with change create.

While working on your project add changelog entries under the ### Unreleased header, following the format described in keep a changelog.

When ready for a new release simply run change 1.0.0 to create the 1.0.0 release. You can run the program with -n to see what it will do.

As a convenience, if the unrelased header is formatted as

## <version> - Unreleased

You do not need to supply a version to change, it'll use the version from the header and make the next unreleased version the following patch version.

The reasoning is that whether the next release will be a major, minor or patch release is most present when adding the changelog entries, and fixing the header at the same time is a way to record this.

Contributing

  1. Fork it (https://github.com/xendk/change/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

change's People

Contributors

xendk 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.