Difference between revisions of "Maven distro directory layout"
From Gcube Wiki
(→distro) |
|||
| Line 1: | Line 1: | ||
| + | The guidelines provided in this page have been decided and being adopted starting from March 2015 | ||
= distro = | = distro = | ||
== README == | == README == | ||
| + | Each gCube component must include a README file that must be included in distribution packages of the component. The file briefly describe the component and the gCube system and provide references to the source code, binaries, documentation as well as to the INSTALL and LICENSE file. | ||
| + | |||
| + | In order to have as much as possible uniform README files across components and to reduce the effort to maintain the file updated, a standardized template is provided. The template makes use of placeholders (delimited by <code>${...}</code>) that are replaced at build-time with the value of Maven properties. This approach allows to keep the same README in the source code while containing always updated information. | ||
| + | |||
| + | This is the README file that all components should have in their <code>distro/</code> folder: | ||
<source lang="text" highlight="21,22,39,40,41"> | <source lang="text" highlight="21,22,39,40,41"> | ||
The gCube System - ${name} | The gCube System - ${name} | ||
| Line 67: | Line 73: | ||
</source> | </source> | ||
| − | + | * the highlighted lines should be replaced with appropriate data | |
| − | * | + | * all the placeholders must correspond to Maven properties. There are two source of properties: |
| + | ** the component <code>pom.xml</code> | ||
| + | ** the gCube <code>maven-parent</code> ([http://maven.research-infrastructures.eu/nexus/index.html#nexus-search;gav~org.gcube.tools~maven-parent[[User:Gabriele.giammatteo|Gabriele.giammatteo]] ([[User talk:Gabriele.giammatteo|talk]]) here]) | ||
| Line 76: | Line 84: | ||
== LICENSE == | == LICENSE == | ||
| − | <source lang="text | + | <source lang="text"> |
${gcube.license} | ${gcube.license} | ||
</source> | </source> | ||
https://joinup.ec.europa.eu/sites/default/files/ckeditor_files/files/eupl%20v%20%201%201%20-%20EN.txt.txt | https://joinup.ec.europa.eu/sites/default/files/ckeditor_files/files/eupl%20v%20%201%201%20-%20EN.txt.txt | ||
Revision as of 16:03, 3 March 2016
The guidelines provided in this page have been decided and being adopted starting from March 2015
distro
README
Each gCube component must include a README file that must be included in distribution packages of the component. The file briefly describe the component and the gCube system and provide references to the source code, binaries, documentation as well as to the INSTALL and LICENSE file.
In order to have as much as possible uniform README files across components and to reduce the effort to maintain the file updated, a standardized template is provided. The template makes use of placeholders (delimited by ${...}) that are replaced at build-time with the value of Maven properties. This approach allows to keep the same README in the source code while containing always updated information.
This is the README file that all components should have in their distro/ folder:
The gCube System - ${name}
--------------------------------------------------
${description}
${gcube.description}
${gcube.funding}
Version
--------------------------------------------------
${version} (${buildDate})
Authors
--------------------------------------------------
* John Doe (john-AT-acme.org), Acme Inc., New York.* [other maintainers]
Download information
--------------------------------------------------
Source code is available from SVN:
${scm.url}
Binaries can be downloaded from the gCube website:
${gcube.website}
Documentation
--------------------------------------------------
Documentation is available on-line in the gCube Documentation Wiki:
Developer Guide - ${gcube.wikiRoot}/[page name here] User Guide - ${gcube.wikiRoot}/[page name here] Admin Guide - ${gcube.wikiRoot}/[page name here]
Installation
--------------------------------------------------
Please see the file named "INSTALL" in this directory.
Support
--------------------------------------------------
Bugs and support requests can be reported in the gcube issue tracking tool:
${gcube.issueTracking}
Licensing
--------------------------------------------------
This software is licensed under the terms you may find in the file named "LICENSE" in this directory.- the highlighted lines should be replaced with appropriate data
- all the placeholders must correspond to Maven properties. There are two source of properties:
- the component
pom.xml - the gCube
maven-parent(Gabriele.giammatteo (talk) here)
- the component
Common properties
Following properties are
LICENSE
${gcube.license}