{"id":23165840,"url":"https://github.com/qxzzxq/scala-archetype","last_synced_at":"2025-04-04T21:27:48.845Z","repository":{"id":41961455,"uuid":"266868886","full_name":"qxzzxq/scala-archetype","owner":"qxzzxq","description":"An up-to-date Maven Archetype for Scala with a bunch of out-of-the-box features 🍻","archived":false,"fork":false,"pushed_at":"2022-08-15T22:05:45.000Z","size":36,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-10T06:14:01.031Z","etag":null,"topics":["archetype","maven-archetype","maven-central","ossrh","scala","scalatest","scoverage","surefire-reporting"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qxzzxq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-25T19:58:42.000Z","updated_at":"2021-07-12T11:34:55.000Z","dependencies_parsed_at":"2022-08-12T00:50:12.273Z","dependency_job_id":null,"html_url":"https://github.com/qxzzxq/scala-archetype","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qxzzxq%2Fscala-archetype","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qxzzxq%2Fscala-archetype/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qxzzxq%2Fscala-archetype/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qxzzxq%2Fscala-archetype/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qxzzxq","download_url":"https://codeload.github.com/qxzzxq/scala-archetype/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247251363,"owners_count":20908496,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["archetype","maven-archetype","maven-central","ossrh","scala","scalatest","scoverage","surefire-reporting"],"created_at":"2024-12-18T01:29:10.499Z","updated_at":"2025-04-04T21:27:48.825Z","avatar_url":"https://github.com/qxzzxq.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# scala-archetype\n![build](https://github.com/qxzzxq/scala-archetype/workflows/build/badge.svg)\n[![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)\n\nAn up-to-date Maven Archetype for Scala with a bunch of out-of-the-box features 🍻\n\n## Features\n- [Scalatest](https://www.scalatest.org/) with [Scoverage](http://scoverage.org/) and [Surefire](https://maven.apache.org/surefire/maven-surefire-plugin/) report\n- [OSSRH](https://central.sonatype.org/pages/ossrh-guide.html) Maven central repository deployment\n- [Apache Spark](https://spark.apache.org/)\n- [Typesasfe config](https://github.com/lightbend/config)\n\n## Usage\n\n#### Interactive mode:\n```shell script\nmvn archetype:generate \\\n  -DarchetypeGroupId=dev.qinx \\\n  -DarchetypeArtifactId=scala-archetype \\\n  -DarchetypeVersion=1.0.0\n```\n\n#### Batch mode\n```shell script\nmvn archetype:generate -B \\\n  -DarchetypeGroupId=dev.qinx \\\n  -DarchetypeArtifactId=scala-archetype \\\n  -DarchetypeVersion=1.0.0 \\\n  -DgroupId=com.company \\\n  -DartifactId=artifact-id \\\n  -Dversion=0.0.1-SNAPSHOT \\\n  -Dpackage=com.company\n```\n\n#### Run test and generate report\nThe following command will run the unit test and generate test report.\n```shell script\nmvn scoverage:report\n```\nSurefire report will be put into `target/surefire-reports`.\n\nScoverage data and report could be found in:\n- `target/scoverage-data`\n- `target/site/scoverage`\n\n#### Deploy to Maven Central Repository\n\nProject created with this archetype is ready to be deployed to Maven Central Repository.\nThe only things you need to do are:\n- prepare your `.m2/settings.xml`\n  ```xml\n  \u003csettings\u003e\n    \u003cprofiles\u003e\n      \u003cprofile\u003e\n        \u003cid\u003eossrh\u003c/id\u003e\n        \u003cactivation\u003e\n          \u003cactiveByDefault\u003etrue\u003c/activeByDefault\u003e\n        \u003c/activation\u003e\n        \u003cproperties\u003e\n          \u003cgpg.executable\u003egpg\u003c/gpg.executable\u003e\n          \u003cgpg.passphrase\u003ethe_pass_phrase\u003c/gpg.passphrase\u003e\n        \u003c/properties\u003e\n      \u003c/profile\u003e\n    \u003c/profiles\u003e\n    \u003cservers\u003e\n      \u003cserver\u003e\n        \u003cid\u003eossrh\u003c/id\u003e\n        \u003cusername\u003eyour-jira-id\u003c/username\u003e\n        \u003cpassword\u003eyour-jira-pwd\u003c/password\u003e\n      \u003c/server\u003e\n    \u003c/servers\u003e\n  \u003c/settings\u003e\n  ```\n- prepare your GPG key\n  ```shell script\n  gpg --import private.key\n  ```\n\nThen, use the following command to deploy the artifact:\n```shell script\n# SNAPSHOT\nmvn deploy -Psnapshot\n\n# RELEASE\nmvn deploy -Prelease\n```\n\nRead the [OSSRH documentation](https://central.sonatype.org/pages/ossrh-guide.html) for more details.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqxzzxq%2Fscala-archetype","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqxzzxq%2Fscala-archetype","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqxzzxq%2Fscala-archetype/lists"}