2019-07-12 16:02:19 +02:00
|
|
|
# TEMPLATES
|
2019-07-10 03:36:22 +02:00
|
|
|
|
2019-07-12 16:02:19 +02:00
|
|
|
This project includes few templates for common files expected to be part of any gCube component holds in a Git repositoryu.
|
2019-07-11 04:56:03 +02:00
|
|
|
|
2019-07-12 16:02:19 +02:00
|
|
|
List of available templates:
|
2020-05-16 06:18:16 +02:00
|
|
|
* [CHANGELOG.md](gCubeComponents/CHANGELOG.md)
|
|
|
|
|
* Keep track of changes.
|
2019-07-12 16:02:19 +02:00
|
|
|
* [README.md](gCubeComponents/README.md)
|
|
|
|
|
* Your Git repo should have a readme file so that viewers know what your code does and how they can get started using it.
|
|
|
|
|
The readme displayed by default when a project opens in Git. It must be customized for each project.
|
|
|
|
|
* [LICENSE.md](gCubeComponents/LICENSE.md)
|
|
|
|
|
* The license file. It's common to all the projects. No need to change it.
|
2019-07-12 16:04:42 +02:00
|
|
|
* [profile.xml](gCubeComponents/profile.xml)
|
2019-07-12 16:02:19 +02:00
|
|
|
* It profiles the gCube component. Need to be customized.
|
|
|
|
|
* [descriptor.xml](gCubeComponents/descriptor.xml)
|
|
|
|
|
* It supports the creation of an archive with the binary artifacts generated by the content of the repository. Customizable if needed.
|
2019-07-10 03:36:22 +02:00
|
|
|
|
2019-07-13 20:47:45 +02:00
|
|
|
All of them must be placed in the root directory of the Git repository.
|
|
|
|
|
|
|
|
|
|
We also provide few snippets useful for common tasks during the Maven build:
|
|
|
|
|
|
|
|
|
|
* [service_archive.xml](gCubeComponents/snippets/service_archive.xml)
|
|
|
|
|
* Execute the maven-assembly-plugin to create the service archive for the component.
|
