Skip to content

Commit

Permalink
docs(README.md): document options for tagging versions
Browse files Browse the repository at this point in the history
2c75c2a added some new options which allow a bit more control
over the semantics of versioning. This CL adds some documentation.

Closes #45
  • Loading branch information
Mike Borozdin authored and caitp committed May 30, 2014
1 parent 2c75c2a commit 2142407
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,26 @@ It's super simple stuff, and I hope some people might find it useful!
3. `stageDir` -- A staging directory where the repository is built and tagged.
4. `main` -- Enables the grunt task to override `bower.json`'s `main` parameter. This will be ignored if it is not a string or an array.
5. `dependencies` -- Enables the grunt task to add dependencies to a build.
6. `extendDependencies` -- If true, the depencies from the source repository will be extended with the grunt options dependencies.
6. `extendDependencies` -- If true, the dependencies from the source repository will be extended with the grunt options dependencies.
7. `branchName` -- (Optional) Specify the branch used for the endpoint.
8. ```overwriteTag``` -- (Optional) If true, a Git tag will be overwritten. The plug-in creates a Git tag in order to specify a package version for ```Bower```.
A tag name is derived from the ```version``` attribute in ```bower.json```. If you have already released a certain version of a package and attempt to do overwrite that version,
the plug-in will fail, because it won't be able to push the same tag twice. The option ensures that a tag is deleted, before it gets pushed again.
9. ```removeVersionTags``` -- (Optional) If true, all Git tags whose name starts with a value of ```version``` in ```bower.json``` will be removed.
10. ```suffixTagWithTimestamp``` -- (Optional) If true, a Git tag will be suffixed with ```+[CURRENT_TIMESTAMP]```, e.g. ```1.0.0-SNAPSHOT+849829134829```

## Files

Files must currently be specified per-task, which is unfortunate and will hopefully be fixed soon.

They may be specified as per the guidelines in [Configuring files](http://gruntjs.com/configuring-tasks#files)

## Releasing Snapshot Version

In some development environments developers prefer to have a snapshot version, which indicates a work in progress. The plug-in allows releasing snapshot versions.
All you have to do is to set ```removeVersionTags``` and ```suffixTagWithTimestamp``` to ```true```.
Those options will ensure that typing ```bower update``` will fetch a new version of a snapshot dependency without having to change ```bower.json``` or clean bower cache.

##License

The MIT License (MIT)
Expand Down

0 comments on commit 2142407

Please sign in to comment.