Difference between revisions of "Zenodo Publication"

From Gcube Wiki
Jump to: navigation, search
Line 70: Line 70:
  
  
== Possible Improvements ==
+
= Citing and Sharing from Zenodo =
 +
TODO: explain how to use the sharing and citing mechanisms of Zenodo
 +
 
 +
= Possible Improvements =
  
 
* Add Changelog in the description
 
* Add Changelog in the description

Revision as of 12:31, 30 November 2016

Motivation

TODO

Automatic Metadata Generation

The content for each deposition is generated automatically by the Zenodo Published from the information in the component source code and in ETICS.

Zenodo.png

1. Title

The title of the deposition is built as follow:

gCube <gCube Version> - <name> v. <version>

where:

  • gCube Version is the version of gCube (e.g. 3.11.1, 4.0.0, ...)
  • name is the content of <name> tag in the pom.xml. If not present, the artifactId is used
  • version is the version in the pom

2. Authors

Built from the content of "vcs.authors" property in ETICS configuration. That property is computed by ETICS looking at the VCS history of the component

3. Description

It corresponds to the content of README file.

4. Files

The only file uploaded is the source package. It is generated during ETICS builds and contains everything checked-out from the VCS

5. GitHub link

The link to the position of the source code in GitHub

6. DOI

assigned by Zenodo to this deposition.

7. Keywords

Keywords for each component are stored in ETICS in the the description field of the corresponding ETICS module (not the configuration). For instance, keywords for "Common Authorization" are stored in the description of "org.gcube.common.authorization-common" module. They are encoded as follow:

#keywords=keyword1, keyword 2, key word3, ...

If keywords are not found in the component, they are searched in the subsystem and if also in the subsystem are not found, the keywords for the project are used. org.gcube project define these keywords:

#keywords=gCube, Java, Data Management System, Hybrid Data Infrastructure


8. Grants

Static list of grants. The same for all depositions

9. Previous Version Reference

The DOI of the previous version of this component

10. GitHub Reference

(same as 5)

11. PackageId

internal identifier to uniquely identify the depositions

12. Commiunity

All depositions belongs to the gCube community

13. License

Statically set to EUPL-1.1

Command line client usage

The source code is at http://svn.research-infrastructures.eu/public/d4science/gcube/trunk/tools/software-publisher-common/

TODO


Citing and Sharing from Zenodo

TODO: explain how to use the sharing and citing mechanisms of Zenodo

Possible Improvements

  • Add Changelog in the description
  • Add links to wiki (parsed from the README)
  • Support for a ".zenodo" file in the projet root that override metadata generated automatically
  • Make a Smartgears service
  • More metadata can be added:
    • Subjects (however Subjects does not appear in Zenodo)