Skip to content

Commit

Permalink
prepares 0.5.0 release
Browse files Browse the repository at this point in the history
- touch up readme further
- travis file
- prepare release bash script
- fixes licence ref in project file
  • Loading branch information
Benedek Fazekas committed Jan 13, 2015
1 parent 1f783ea commit ce029f3
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 9 deletions.
7 changes: 7 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
language: clojure
script:
- lein2 test
jdk:
- openjdk7
- oraclejdk7
- oraclejdk8
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Build Status](https://travis-ci.org/MailOnline/gargamel.png?branch=master)](https://travis-ci.org/MailOnline/gargamel)

# gargamel

You have all these little blue issues on github, jira and commits running around and you want to catch them! Gargamel is really enthusiastic to do just that but he never really succeeds, does he?
Expand All @@ -8,8 +10,6 @@ You have all these little blue issues on github, jira and commits running around

There are two interfaces for gargamel: either use the lein plugin for clojure projects managed by leiningen or use the CLI interface for all other projects.

Note that currently gargamel expects release tags in the following format: `release-buildnumber-date_time` matching the pattern `release-\d+-\d+_\d+`.

### Prerequisites

java runtime environment: basically `java -jar` should work.
Expand All @@ -36,20 +36,22 @@ To install clone the github project and put gargamel/bin on your PATH. Run

$ gargamel.sh -h

for built in help. You can generate custom changelog for Release Candidate provide two refs (tags or commits):
help. You can generate custom changelog for Release Candidate providing two refs (tags or commits):

$ gargamel.sh -f 4adf1fe853d9c082346cd4b029f1c868abb9d663 -t 50848867e66d6462c3af7427dbdf54f6553d12c0 -p clj_fe -d /tmp/

Or to generate the latest releaase notes changelog between the two latest releaase tags:
Or to generate the latest release notes changelog between the two latest release tags:

$ gargamel.sh -v -r -p clj_fe -d /tmp/

Note that by default gargamel expects release tags in the following format: `release-buildnumber-date_time` matching the pattern `release-\d+-\d+_\d+`. This is however configurable with `-x` or `--releate-tag-pattern`

## Project specific config file

Gargamel looks for a file named `gargamel.edn` in the project's directory. This file should be in [edn format](https://github.com/edn-format/edn).
Gargamel looks for a file named `gargamel.edn` in the project's directory. This file needs to be in [edn format](https://github.com/edn-format/edn).

Please see example config files:
- [config file](gargamel.edn) for markdown output, please see **comments** in this file explaining the config file format
- [config file](gargamel.edn) for markdown output, please see **comments** for explanation of the config file format
- [config file](gargamel-html.edn) for html output

Other output formats are supported by the appropriate set of templates and setting the `:output-extension` in `gargamel.edn` to the appropriate extension.
Expand Down
Binary file modified bin/gargamel.jar
Binary file not shown.
7 changes: 7 additions & 0 deletions prepare-release.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/bash

lein do clean, test, uberjar
cp target/gargamel-*-standalone.jar bin/gargamel.jar

cd bin
tar czvf ../target/gargamel-latest.tgz *.*
6 changes: 3 additions & 3 deletions project.clj
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
(defproject gargamel "0.5.0-alpha1"
(defproject gargamel "0.5.0"
:description "Generates changelog between two git refs."
:url "https://github.com/MailOnline/gargamel"
:license {:name "Eclipse Public License"
:url "http://www.eclipse.org/legal/epl-v10.html"}
:license {:name "GNU General Public License, version 3"
:url "http://opensource.org/licenses/GPL-3.0"}
:dependencies [[org.clojure/clojure "1.6.0"]
[stencil "0.3.2" :exclusions [org.clojure/clojure]]
[org.clojure/tools.cli "0.3.1":exclusions [org.clojure/clojure]]
Expand Down

0 comments on commit ce029f3

Please sign in to comment.