Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reordered main doc content #22

Merged
merged 1 commit into from
Oct 5, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 24 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,12 @@ No more infamous "version bump" commits in every release!
This plugin is **tiny** and has a single dependency on https://github.com/zafarkhaja/jsemver.
It is a safe dependency because it is tiny, has no dependencies, and it is final (no code changes since 2015 - it wraps semver protocol that had [no changes since 2013](https://github.com/semver/semver/tree/v2.0.0)).

## Other plugins
## Customers / sample projects

There are other plugins out there that are similar:

1. Below 2 plugins are great but they (mostly) require to push a tag to make a release.
Our plugin can release every change.
- https://github.com/ajoberstar/reckon
- https://github.com/allegro/axion-release-plugin
- https://github.com/cinnober/semver-git

2. Below plugin can release every change but the resulting version is not as nice (e.g. ```1.0.0+3bb4161```).
The plugin has many features and thus is much more complex than our plugin.
- https://github.com/tschulte/gradle-semantic-release-plugin

Use the plugin that works best for you and push every change to production!

Discussion about this use case: https://github.com/mockito/shipkit/issues/395
- https://github.com/shipkit/shipkit-demo (great example/reference project)
- https://github.com/shipkit/shipkit-changelog (this project)
- https://github.com/shipkit/shipkit-auto-version
- https://github.com/linkedin/ambry

## Usage

Expand Down Expand Up @@ -56,13 +45,8 @@ Example:
```
println project.ext.'shipkit-auto-version.previous-version'
```

## Customers

- https://github.com/linkedin/ambry
- https://github.com/shipkit/org.shipkit.shipkit-auto-version

## Implementation
## Implementation details

When the plugin is applied to the project it will:

Expand All @@ -89,3 +73,21 @@ d 1.*.5 error unsupported format
- run `git log` to identify # of commits
- add commit count to the patch version value from the latest tag
- viola! we got the version to use!

## Similar plugins

There are other plugins out there that are similar:

1. Below 2 plugins are great but they (mostly) require to push a tag to make a release.
Our plugin can release every change.
- https://github.com/ajoberstar/reckon
- https://github.com/allegro/axion-release-plugin
- https://github.com/cinnober/semver-git

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also add https://github.com/nemerosa/versioning here. It's very good plugin

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add this plugin with a little narrative? (perhaps 1 sentence describing it)? Thanks!


2. Below plugin can release every change but the resulting version is not as nice (e.g. ```1.0.0+3bb4161```).
The plugin has many features and thus is much more complex than our plugin.
- https://github.com/tschulte/gradle-semantic-release-plugin

Use the plugin that works best for you and push every change to production!

Discussion about this use case: https://github.com/mockito/shipkit/issues/395