Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/qxzzxq/scala-archetype

An up-to-date Maven Archetype for Scala with a bunch of out-of-the-box features 🍻
https://github.com/qxzzxq/scala-archetype

archetype maven-archetype maven-central ossrh scala scalatest scoverage surefire-reporting

Last synced: 4 days ago
JSON representation

An up-to-date Maven Archetype for Scala with a bunch of out-of-the-box features 🍻

Host: GitHub
URL: https://github.com/qxzzxq/scala-archetype
Owner: qxzzxq
License: apache-2.0
Created: 2020-05-25T19:58:42.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-08-15T22:05:45.000Z (over 2 years ago)
Last Synced: 2023-12-02T12:20:35.683Z (about 1 year ago)
Topics: archetype, maven-archetype, maven-central, ossrh, scala, scalatest, scoverage, surefire-reporting
Language: Scala
Homepage:
Size: 35.2 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# scala-archetype
![build](https://github.com/qxzzxq/scala-archetype/workflows/build/badge.svg)
[![Maven Central](https://img.shields.io/maven-central/v/dev.qinx/scala-archetype.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22dev.qinx%22%20AND%20a:%22scala-archetype%22)

An up-to-date Maven Archetype for Scala with a bunch of out-of-the-box features 🍻

## Features
- [Scalatest](https://www.scalatest.org/) with [Scoverage](http://scoverage.org/) and [Surefire](https://maven.apache.org/surefire/maven-surefire-plugin/) report
- [OSSRH](https://central.sonatype.org/pages/ossrh-guide.html) Maven central repository deployment
- [Apache Spark](https://spark.apache.org/)
- [Typesasfe config](https://github.com/lightbend/config)

## Usage

#### Interactive mode:
```shell script
mvn archetype:generate \
-DarchetypeGroupId=dev.qinx \
-DarchetypeArtifactId=scala-archetype \
-DarchetypeVersion=1.0.0
```

#### Batch mode
```shell script
mvn archetype:generate -B \
-DarchetypeGroupId=dev.qinx \
-DarchetypeArtifactId=scala-archetype \
-DarchetypeVersion=1.0.0 \
-DgroupId=com.company \
-DartifactId=artifact-id \
-Dversion=0.0.1-SNAPSHOT \
-Dpackage=com.company
```

#### Run test and generate report
The following command will run the unit test and generate test report.
```shell script
mvn scoverage:report
```
Surefire report will be put into `target/surefire-reports`.

Scoverage data and report could be found in:
- `target/scoverage-data`
- `target/site/scoverage`

#### Deploy to Maven Central Repository

Project created with this archetype is ready to be deployed to Maven Central Repository.
The only things you need to do are:
- prepare your `.m2/settings.xml`
```xml

ossrh

true

gpg
the_pass_phrase

ossrh
your-jira-id
your-jira-pwd

```
- prepare your GPG key
```shell script
gpg --import private.key
```

Then, use the following command to deploy the artifact:
```shell script
# SNAPSHOT
mvn deploy -Psnapshot

# RELEASE
mvn deploy -Prelease
```

Read the [OSSRH documentation](https://central.sonatype.org/pages/ossrh-guide.html) for more details.