Skip to content

Commit

Permalink
Merge pull request #48 from otakup0pe/mjuarez/docs-update
Browse files Browse the repository at this point in the history
First pass at more relevant docs
  • Loading branch information
otakup0pe authored Mar 15, 2021
2 parents b34ef6c + 2a9ccee commit a24b959
Showing 1 changed file with 57 additions and 10 deletions.
67 changes: 57 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ avakas

[![PyPI](https://img.shields.io/pypi/v/avakas.svg)](https://pypi.python.org/pypi/avakas)[![Maintenance](https://img.shields.io/maintenance/yes/2021.svg)]()


# Overview

This script provides a simple interface around viewing and manipulating project
Expand Down Expand Up @@ -31,8 +32,10 @@ The avakas tool supports the following types of version files
* NodeJS `package.json`
* Erlang/OTP and rebar `foo.app.src`
* Chef Cookbook `metadata.rb`
* Ansible `meta/main.yml`
* Plain ol' `version` file


# Operations

## show
Expand All @@ -51,7 +54,6 @@ a string. The `--pre-build-prefix=foo` option will include a string prefix. It
is possible to include both pre-build _and_ build information, but only if you
specify a prefix or include the date in prebuild.


```shell
avakas show $HOME/projects/hal9000
```
Expand Down Expand Up @@ -84,31 +86,75 @@ hints can be specified at any point in the commit message. The hints are
specified, prefixed by `bump:`. For example, the following commit message would
result in a minor version bump if it is subsequently "autobumped".

```
```shell
$ avakas show .
0.0.1
$ git commit -am "hello this is a release\nbump:minor"
$ avakas bump . auto
Version updated from 0.0.1 to 0.1.0
```

Avakas can also rely on a default bump version to ensure every invocation of Avakas generates a bump build. If a bump hint is not detected within the commit history, the defined defualt-bump level will be used. This is useful for CI/CD systems.

```shell
avakas bump . auto --default-bump patch
```


# Arguments

### `--dry-run`
## --tag-prefix

A prefix to use with the version. Generally used for non-semantic version compliant v1.0 style version strings.

## --branch

The authoritative mainline branch of your project. This is also used to compare for prereleases.

## --remote

The git remote origin to push changes to.

This will result in nothing being pushed to upstream git sources.
## --filename

### `--branch`
The filename to use for generating a version file.

The branch to use when updating git.
## --flavor

### `--remote`
Flavor of project (Presently: legacy|chef|ansible|nodejs|erlang).

The remote to push tags and version updates.
## --build-meta

### `--tag-prefix`
Whether to apply semantic version compliant build metadata to the version. (Example: `1.0.0+4c5fa2.1`)

## --skip-dirty

Skip checking if local repo is dirty.

## --skip-commit-changes

Skip committing generated version files.

## --with-hooks

Run git hooks during operations.

## --dry-run

Will not push to git.

## --prerelease

Will attempt to generate a prerelease version. (Example: `1.0.0-1`)

## --prerelease-date

Will attach the data to the prerelease identifiers. (Example: `1.0.0-1.20201220`)

## --prerelease-prefix

Will use a prefix for the prerelease. (Example: `1.0.0-alpha.1`)

This prefix will be added to the version string when creating a git tag.

# Docker

Expand Down Expand Up @@ -159,6 +205,7 @@ generates a coverage report from the integration tests.

[MIT](https://github.com/otakup0pe/avakas/blob/master/LICENSE)


# Author

The avakas tool was created by [Jonathan Freedman](http://jonathanfreedman.bio/)
Expand Down

0 comments on commit a24b959

Please sign in to comment.