Package releasing made easy.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
commands
configuration
dist
utils
.gitignore
CHANGELOG.md
Gopkg.lock
Gopkg.toml
Impaccafile
LICENSE.md
Magefile.go
README.md
installer
main.go

README.md

impacca

Release Go Report Card License

Package releasing made easy.

http://sw.cowtech.it/impacca

Installation

Type the following inside a fish shell and you're done!

curl -sL http://sw.cowtech.it/impacca/installer | sudo bash

impicca will be installed in /usr/local/bin.

Usage

impacca is able to help you in maintaining the CHANGELOG.md file and the version for npm modules, Ruby gems and standalone git repository.

It is strongly opinionated, but it should work for most common use cases.

To see all the possible commands, simple run:

impacca -h

Configuration

impacca tries to find a .impacca.json in the current working directory and all its parents and in your home directory.

Here's a list of supported configuration fine (with their default):

{
  "commitMessages": {
    "changelog": "Updated CHANGELOG.md.", // Message used to commit changelog updates.
    "versioning": "Version %s." // Message used to commit version updates. %s will be replaced with the NEW version
  }
}

When releasing a new version in plain GIT repository, impacca will also look for Impaccafile executable script. This script will be executed prior commiting the changes and will receive the NEW version as first argument and the OLD version as second argument. You can find an example of a Impaccafile in this repository (which uses this feature).

Contributing to impacca

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.

Copyright

Copyright (C) 2018 and above Shogun (shogun@cowtech.it).

Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.