Skip to content

initial publishing setup, readme updates #2

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

initial publishing setup, readme updates #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
74 changes: 74 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,77 @@ The path to the unsigned module.

### module-out
The path the signed module will be written to.


## Using as a Library via Maven

This library has been built and published to the Inductive Automation artifact repository. To use this as a dependency in a JVM project, simply add the IA repo to your artifact repositories, and then add as a typical maven dependency.


#### Consuming Via Maven POM

```
// in pom.xml

<repositories>
<repository>
<id>ia-releases</id>
<releases>true</releases>
<snapshots>false</snapshots>
<url>https://nexus.inductiveautomation.com/repository/inductiveautomation-releases/</url>
</repository>
</repositories>
</project>

<dependencies>
<dependency>
<groupId>com.inductiveautomation.ignitionsdk</groupId>
<artifactId>module-signer</artifactId>
<version>YOUR_DESIRED_VERSION</version>
</dependency>
</dependencies>
```

#### Consuming Via Gradle buildscript

```
// in build.gradle
repositories {
maven { url "https://nexus.inductiveautomation.com/repository/inductiveautomation-releases/" }
}

dependencies {
implementation("com.inductiveautomation.ignitionsdk:module-signer:YOUR_DESIRED_VERSION")
}

```


## Artifact Publishing

To publish a copy of this artifact to a private repo, you'll need to configure your server settings as described in the [Maven deploy documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html). Specify the repo urls by directly editing the POM file and setting the urls. Alternatively, you may set the properties through an active profile in your settings.xml file (generally located at `${user.home}/.m2/settings.xml`) as demonstrated below.

Then simply execute `mvn deploy` to publish to your private repository. For development and testing, `mvn install` will install the assembled artifact to your local maven .m2 repository.


```
<settings>
<profiles>
<profile>
<id>inject-repo-url</id>
<properties>
<snapshotsRepoUrl>http://your-artifact-host/repository/snapshots/</snapshotsRepoUrl>
<releasesRepoUrl>http://your-artifact-host/repository/releases/</releasesRepoUrl>
</properties>
</profile>
</profiles>
<activeProfiles>
<activeProfile>inject-repo-url</activeProfile>
</activeProfiles>

// ...

</settings>

```

39 changes: 39 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@
<artifactId>module-signer</artifactId>
<version>1.0.0-SNAPSHOT</version>

<scm>
<url>https://github.com/inductiveautomation/module-signer</url>
<connection>scm:git:git://github.com/inductiveautomation/module-signer.git</connection>
<developerConnection>scm:git:git@github.com:inductiveautomation/module-signer.git</developerConnection>
<tag>HEAD</tag>
</scm>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>

<dependencies>
<dependency>
<groupId>commons-cli</groupId>
Expand Down Expand Up @@ -66,7 +78,34 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>2.8.2</version>
<executions>
<execution>
<id>default-deploy</id>
<phase>deploy</phase>
<goals>
<goal>deploy</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

<distributionManagement>
<snapshotRepository>
<id>snapshots</id>
<!--suppress UnresolvedMavenProperty -->
<url>${snapshotsRepoUrl}</url>
</snapshotRepository>
<repository>
<id>releases</id>
<!--suppress UnresolvedMavenProperty -->
<url>${releasesRepoUrl}</url>
</repository>
</distributionManagement>

</project>