Skip to content
This repository has been archived by the owner on Mar 12, 2021. It is now read-only.

A template repository for new Quarkiverse repositories

License

Notifications You must be signed in to change notification settings

quarkiverse/quarkiverse-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⚠ This project has been archived in favor of using the plugin below. See the thread for more details: https://groups.google.com/g/quarkus-dev/c/7D-mXOw-xc0/m/xFr0mb3OAQAJ

Welcome to Quarkiverse!

Congratulations and thank you for creating a new Quarkus extension project in Quarkiverse!

Feel free to replace this content with the proper description of your new project and necessary instructions how to use and contribute to it.

You can find the basic info, Quarkiverse policies and conventions in the Quarkiverse wiki.

Need to quickly create a new Quarkus extension Maven project? Just execute the command below replacing the template values with your preferred ones:

mvn io.quarkus:quarkus-maven-plugin:<QUARKUS_VERSION>:create-extension -N \
    -DgroupId=io.quarkiverse.<REPO_NAME> \ 
    -DartifactId=<EXTENSION_ARTIFACT_ID> \  
    -Dversion=<INITIAL_VERSION> \ 
    -Dquarkus.nameBase="<EXTENSION_SIMPLE_NAME>"

IMPORTANT: make sure your project uses io.quarkiverse:quarkiverse-parent as the parent POM. It will make sure the release and artifact publishing plugins are properly configured for your project.

In case you are creating a Quarkus extension project for the first time, please follow Building My First Extension guide.

Other useful articles related to Quarkus extension development can be found under the Writing Extensions guide category on the Quarkus.io website.

Thanks again, good luck and have fun!

Documentation

The documentation for this extension should be maintained as part of this repository and it is stored in the docs/ directory.

The layout should follow the Antora's Standard File and Directory Set.

Once the docs are ready to be published, please open a PR including this repository in the Quarkiverse Docs Antora playbook. See an example here.

About

A template repository for new Quarkiverse repositories

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published