Skip to content

Commit

Permalink
issue #1
Browse files Browse the repository at this point in the history
  • Loading branch information
melahn committed Apr 30, 2020
1 parent 662f684 commit 3059bd4
Show file tree
Hide file tree
Showing 6 changed files with 121 additions and 7 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [1.0.2] - 2020-04-30
### Changed
- Setup for publishing to maven central

## [1.0.1] - 2020-04-26
### Added
- helm-chartmap-generator-1.0.1.jar
Expand All @@ -19,5 +23,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## 1.0.0 - 2020-04-26
- Initial version

[Unreleased]: https://github.com/melahn/helm-chartmap-generator/compare/v1.0.1...HEAD
[Unreleased]: https://github.com/melahn/helm-chartmap-generator/compare/v1.0.2...HEAD
[1.0.2]: https://github.com/melahn/helm-chartmap-generator/compare/v1.0.1...v1.0.2
[1.0.1]: https://github.com/melahn/helm-chartmap-generator/compare/v1.0.0...v1.0.1
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# helm-chartmap-generator
![version](https://img.shields.io/badge/version-1.0.1-green)
![version](https://img.shields.io/badge/version-1.0.2-green)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

## Overview
Expand All @@ -16,19 +16,32 @@ and provided links to view them.

You can see lots of examples here -> https://melahn.github.io/helm-chartmap-generator/

## Maven Central

The jar file, along with source and javadoc, is available from **Maven Central**.
```
<dependency>
<groupId>com.melahn</groupId>
<artifactId>helm-chartmap-generator</artifactId>
<version>1.0.2</version>
</dependency>
```

## Prerequisites

* Java 8 or later.

## Usage

1. Download the executable jar from the [resource directory](./resource/jar), or build it yourself from source (see below).
1. Download the executable jar from the [resource directory](./resource/jar),
or download it from [Maven Central](https://oss.sonatype.org/service/local/repositories/releases/content/com/melahn/helm-chartmap-generator/1.0.2/helm-chartmap-generator-1.0.2.jar)
or build it yourself from source (see below).

2. Run the command line. See Syntax and Examples below.

### Command Line Syntax
```
java -jar helm-chartmap-generator-1.0.1.jar
java -jar helm-chartmap-generator-1.0.2.jar
Flags:
-r <repo name> the name of the local helm repo to use (required)
Expand Down Expand Up @@ -67,12 +80,12 @@ Flags:

##### Generating reports from the incubator repo using all the detaults
```
java -helm-chartmap-generator-1.0.1.jar -r incubator
java -helm-chartmap-generator-1.0.2.jar -r incubator
```
##### Generating JSON and PlantUML reports from the stable repo, with up to 3 versions printed with verbose output
```
java -helm-chartmap-generator-1.0.1.jar -r stable -f pt -n 3 -v
java -helm-chartmap-generator-1.0.2.jar -r stable -f pt -n 3 -v
```

### Notes
Expand Down
98 changes: 97 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,39 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.melahn</groupId>
<artifactId>helm-chartmap-generator</artifactId>
<version>1.0.1</version>
<version>1.0.2</version>
<name>${project.groupId}:${project.artifactId}</name>
<description>A tool that generates a set of helm dependency reports in various formats for a given helm chart repository</description>
<url>https://github.com/melahn/helm-chartmap-generator</url>
<licenses>
<license>
<name>MIT License</name>
<url>http://www.opensource.org/licenses/mit-license.php</url>
</license>
</licenses>
<scm>
<connection>scm:git:git://github.com/melahn/helm-chartmap-generator.git</connection>
<developerConnection>scm:git:ssh://github.com:melahn/helm-chartmap-generator.git</developerConnection>
<url>https://github.com/melahn/helm-chartmap-generator/tree/master</url>
</scm>
<developers>
<developer>
<name>Gregory Melahn</name>
<email>gregorymelahn@gmail.com</email>
<organization>melahn.com</organization>
<organizationUrl>http://melahn.com</organizationUrl>
</developer>
</developers>
<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
<repository>
<id>ossrh</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
Expand All @@ -23,6 +55,68 @@
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.8</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
</configuration>
<dependencies>
<!-- https://mvnrepository.com/artifact/org.apache.httpcomponents/httpcore -->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpcore</artifactId>
<version>4.4.6</version>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.2.1</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version>
<configuration>
<source>8</source>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.5</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
Expand Down Expand Up @@ -96,6 +190,8 @@
<directory>${basedir}/target</directory>
<includes>
<include>${project.artifactId}-${project.version}.jar</include>
<include>${project.artifactId}-${project.version}-javadoc.jar</include>
<include>${project.artifactId}-${project.version}-sources.jar</include>
</includes>
</resource>
</resources>
Expand Down
Binary file not shown.
Binary file not shown.
Binary file added resource/jar/helm-chartmap-generator-1.0.2.jar
Binary file not shown.

0 comments on commit 3059bd4

Please sign in to comment.