https://github.com/kevinsawicki/github-maven-example
Example project using GitHub Maven Plugins
https://github.com/kevinsawicki/github-maven-example
java
Last synced: 10 months ago
JSON representation
Example project using GitHub Maven Plugins
- Host: GitHub
- URL: https://github.com/kevinsawicki/github-maven-example
- Owner: kevinsawicki
- Created: 2011-09-02T01:11:54.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2023-12-22T17:11:32.000Z (about 2 years ago)
- Last Synced: 2025-04-03T19:14:07.978Z (10 months ago)
- Topics: java
- Language: Java
- Homepage: http://kevinsawicki.github.com/github-maven-example
- Size: 138 KB
- Stars: 138
- Watchers: 4
- Forks: 934
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is an example project that uses the [GitHub Maven Plugins](https://github.com/github/maven-plugins).
See the [POM file](https://github.com/kevinsawicki/github-maven-example/blob/master/example/pom.xml)
for how the downloads plugin and site plugin are configured.
# Getting started
* Fork this project
* Update the `pom.xml` file `` element to be the address of your fork
* Optionally update `` and `` section as well to have the information for your fork
* Add the following to your Maven `settings.xml` file updated with your GitHub login name and password:
```xml
github
user
password
```
# Using the downloads plugin
```
$ cd github-maven-example/example
$ mvn clean install
```
The compiled, source, and Javadoc JAR files will be uploaded as downloads [here](https://github.com/kevinsawicki/github-maven-example/downloads).
# Using the site plugin
```
$ cd github-maven-example/example
$ mvn site
```
The generated site will be committed to the [gh-pages branch](https://github.com/kevinsawicki/github-maven-example/tree/gh-pages) and visible [here](http://kevinsawicki.github.com/github-maven-example/).