This repository has been archived by the owner on Jun 7, 2021. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update root README and links to JIRA.
- Loading branch information
1 parent
a59df8c
commit 221c6d7
Showing
4 changed files
with
77 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
= WildFly-Swarm Examples | ||
|
||
> Please raise any issues found with this example in this repo: | ||
> https://github.com/wildfly-swarm/wildfly-swarm-examples/issues | ||
> | ||
> Issues related to *WildFly Swarm* core should be raised in our JIRA: | ||
> https://issues.jboss.org/browse/SWARM | ||
|
||
== WildFly Swarm | ||
|
||
This repository contains examples for the http://wildfly-swarm.io[WildFly Swarm] project. | ||
|
||
It is currently listed as *alpha* release software, subject to massive, possibly-breaking, | ||
changes as we determine exactly how it should all hang together. | ||
|
||
== These Examples | ||
|
||
These examples demonstrate utilizing and combining different different parts of WildFly to create | ||
a self-contained executable jar. They provide small, specific, working examples that can be used | ||
as a reference for your own project. | ||
|
||
By default, this repository uses `SNAPSHOT` versions of WildFly Swarm. They are used to test | ||
particular aspects of the WildFly Swarm project in addition to being useful examples of what | ||
you can do and how you can do it. | ||
|
||
Since these examples are `SNAPSHOT`-centric, our *snapshot* repository is added to the | ||
root `pom.xml`. If you were to build https://github.com/wildfly-swarm/wildfly-swarm[WildFly Swarm] | ||
directly, that would of course take precedence. | ||
|
||
If you want to use our *snapshot* repository in your own projects, include this in your `pom.xml`: | ||
|
||
[source,xml] | ||
---- | ||
<repositories> | ||
<repository> | ||
<id>projectodd-snapshots</id> | ||
<name>Project:odd Snapshots from CI</name> | ||
<url>https://repository-projectodd.forge.cloudbees.com/snapshot</url> | ||
<releases> | ||
<enabled>false</enabled> | ||
</releases> | ||
<snapshots> | ||
<enabled>true</enabled> | ||
</snapshots> | ||
</repository> | ||
</repositories> | ||
<pluginRepositories> | ||
<pluginRepository> | ||
<id>projectodd-snapshots</id> | ||
<name>Project:odd Snapshots from CI</name> | ||
<url>https://repository-projectodd.forge.cloudbees.com/snapshot</url> | ||
<releases> | ||
<enabled>false</enabled> | ||
</releases> | ||
<snapshots> | ||
<enabled>true</enabled> | ||
</snapshots> | ||
</pluginRepository> | ||
</pluginRepositories> | ||
---- | ||
|
||
To run the examples for a given release, please clone and checkout the particular Git tag | ||
or https://github.com/wildfly-swarm/wildfly-swarm-examples/releases[download from the releases]. | ||
|
||
== UberJar vs non | ||
|
||
By default, each example runs using the Maven plugin without constructing | ||
an *uberjar*. To run them as an *uberjar*, use the `-Puberjar` profile | ||
when invoking Maven. | ||
|
||
mvn install -Puberjar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters