Skip to content
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

updated README.md with central instructions #27

Merged
merged 3 commits into from
Mar 30, 2022
Merged

updated README.md with central instructions #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
949bc12
updated README.md with central instructions
johnsall Mar 23, 2022
b09251f
re-added sonatype plugins
johnsall Mar 23, 2022
bc9cc9b
Merge branch 'main' into readme_maven_central
johnsall Mar 30, 2022
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
3 changes: 0 additions & 3 deletions .vscode/settings.json
View file
Open in desktop

This file was deleted.

57 changes: 10 additions & 47 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,12 @@ There are four ways to integrate this module into your project:
In the `parent` section of your application's `pom.xml` add:

```xml
<parent>
<groupId>com.amido.stacks.modules</groupId>
<artifactId>stacks-modules-parent</artifactId>
<version>{LATEST_VERSION}</version>
</parent>
<dependency>
<groupId>com.amido.stacks.modules</groupId>
<artifactId>stacks-modules-parent</artifactId>
<version>1.0.1-RC5</version>
<type>pom</type>
</dependency>
```

Then you can do a `./mvnw clean compile` to fetch it; after that, you can use it like any other dependency.
Expand All @@ -57,9 +58,10 @@ Use it as you'd use any dependency in your build tool.

### Localized solution using Maven Archetypes

If you wish to customise the module and use your organisation's namespaces instead of Amido's. You can create a
[Maven archetype](https://maven.apache.org/archetype/index.html). Archetype is Maven's tool for
scaffolding and offers lots of extra functionality. We suggest spending some time looking into them. We use Archetype to create a template and enable you to adopt this module under your organisation's namespace.
If you wish to customise the module and use your organisation's namespaces instead of Amido's, you can create a
[Maven archetype](https://maven.apache.org/archetype/index.html). Archetypes are Maven's tool for
scaffolding and offers lots of extra functionality. We suggest spending some time looking into them.
We use Archetype to create a template and enable you to adopt this module under your organisation's namespace.
To use the deployed archetypes:

1. Make and move to a new folder
Expand Down Expand Up @@ -162,42 +164,3 @@ To build, install and use the archetype follow these steps:
>- Update them manually
>- Re-create the relevant `import` statements to use the new-made module instead
>- If you plan to use this with Amido Stacks, include your namespace in the `@ComponentScan` annotation of the `Application` class.

## Accessing Artifactory

Our artefacts and archetypes get hosted on an Artifactory repository. To use either, from a project
other than Amido Stacks, you will need to add that repo in your `pom.xml`:

```xml
<repositories>
<repository>
<snapshots />
<id>snapshots</id>
<name>default-maven-virtual</name>
<url>https://amidostacks.jfrog.io/artifactory/default-maven-virtual</url>
</repository>
</repositories>
```

Alternatively, you can also add this configuration as a profile in your Maven's `settings.xml` file
in the `.m2` folder in your home directory (any OS):

```xml
<profiles>
<profile>
<repositories>
<repository>
<snapshots/>
<id>snapshots</id>
<name>default-maven-virtual</name>
<url>https://amidostacks.jfrog.io/artifactory/default-maven-virtual</url>
</repository>
</repositories>
<id>artifactory</id>
</profile>
</profiles>

<activeProfiles>
<activeProfile>artifactory</activeProfile>
</activeProfiles>
```
52 changes: 4 additions & 48 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>com.amido.stacks.modules</groupId>
<artifactId>stacks-modules-parent</artifactId>
<version>1.0.0-RC6</version>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>${project.groupId}:${project.artifactId}</name>
<description>The parent for all Stacks modules</description>
Expand All @@ -17,13 +17,14 @@
<url>http://www.opensource.org/licenses/mit-license.php</url>
</license>
</licenses>
<packaging>pom</packaging>

<developers>
<developer>
<name>Amido</name>
<email>[email protected]</email>
<organization>Sonatype</organization>
<organizationUrl>http://www.sonatype.com</organizationUrl>
<organization>Amido</organization>
<organizationUrl>http://www.amido.com</organizationUrl>
</developer>
</developers>

Expand Down Expand Up @@ -304,14 +305,6 @@
</exclusion>
</exclusions>
</dependency>
<!--
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-keyvault-secrets-spring-boot-starter</artifactId>
<version>${azure.springboot.version}</version>
<scope>runtime</scope>
</dependency>
-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
Expand Down Expand Up @@ -683,43 +676,6 @@
</execution>
</executions>
</plugin>


<!-- FIXME: mutation testing disabled for simplicity for now -->
<!-- <plugin>-->
<!-- <groupId>org.pitest</groupId>-->
<!-- <artifactId>pitest-maven</artifactId>-->
<!-- <version>${pitest.version}</version>-->
<!-- <dependencies>-->
<!-- <dependency>-->
<!-- <groupId>org.pitest</groupId>-->
<!-- <artifactId>pitest-junit5-plugin</artifactId>-->
<!-- <version>0.14</version>-->
<!-- </dependency>-->
<!-- </dependencies>-->
<!-- <executions>-->
<!-- <execution>-->
<!-- <id>pitest</id>-->
<!-- <phase>verify</phase>-->
<!-- <goals>-->
<!-- <goal>mutationCoverage</goal>-->
<!-- </goals>-->
<!-- </execution>-->
<!-- </executions>-->
<!-- <configuration>-->
<!-- <threads>15</threads>-->
<!-- <historyInputFile>target/pitHistory.txt</historyInputFile>-->
<!-- <historyOutputFile>target/pitHistory.txt</historyOutputFile>-->
<!-- <timestampedReports>false</timestampedReports>-->
<!-- <mutators>-->
<!-- <value>STRONGER</value>-->
<!-- </mutators>-->
<!-- <outputFormats>-->
<!-- <outputFormat>XML</outputFormat>-->
<!-- <outputFormat>HTML</outputFormat>-->
<!-- </outputFormats>-->
<!-- </configuration>-->
<!-- </plugin>-->
</plugins>
</build>

Expand Down