Skip to content

Two minor doc updates #60

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 13, 2013
Merged

Two minor doc updates #60

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aed810c
Include a mention of the default phase, initialize, with US spelling,…
fredcooke Jan 13, 2013
d544ccf
Add a new section describing how to do it without spring or propertie…
fredcooke Jan 13, 2013
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
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ But I highly recommend using only stable versions, from maven central... :-)

Using the plugin
----------------
It's really simple to setup this plugin, here's a sample pom that you may base your **pom.xml** on:
It's really simple to setup this plugin; below is a sample pom that you may base your **pom.xml** on. Note that it binds to the initialize phase by default such that all Git properties are available for use throughout the build lifecycle.

```xml
<?xml version="1.0" encoding="UTF-8"?>
Expand Down Expand Up @@ -382,6 +382,11 @@ public GitRepositoryState(Properties properties)
}
```

Yet another way to use the plugin
=================================

Rather than reading properties files at runtime or injecting with spring, you can filter a Java source file directly and place it into src/main/java with an ignore, or into generated sources directory within the target directory. This has some minor advantages and disadvantages, but is useful for avoiding runtime injection or lookup from properties files that might get lost during repackaging later if used within a library.

Git describe - short intro to an awesome command
==================================================
Git's [describe command](http://www.kernel.org/pub/software/scm/git/docs/git-describe.html) is the best way to really see "where" a commit is in the repositories "timeline".
Expand Down